A Sandcastle Documented Class Library

# HierarchyData Class

The data contract class for IHierarchy class.
Inheritance Hierarchy
System
Object
Dundas.BI.WebApi.Models
BaseDataContract
Dundas.BI.WebApi.Models
UniqueNameData
Dundas.BI.WebApi.Models
ElementData
Dundas.BI.WebApi.Models
AnalysisElementData
Dundas.BI.WebApi.Models
HierarchyData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    [DataContractAttribute]
    public class HierarchyData : AnalysisElementData

    <DataContractAttribute>
    Public Class HierarchyData
    	Inherits AnalysisElementData

    [DataContractAttribute]
    public ref class HierarchyData : public AnalysisElementData

    [<DataContractAttribute>]
    type HierarchyData =
        class
            inherit AnalysisElementData
        end

The HierarchyData type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| HierarchyData | Initializes a new instance of the HierarchyData class.

Top
Properties

| Name | Description
--- | --- | ---
| AllMember | Gets the "All Values Grouped" member when the hierarchy is aggregatable; otherwise it return .
| AllMemberCaption | Gets or sets the override for "All" member caption.
| AnalysisStructureId | Gets or sets the ID of the analysis structure. (Inherited from AnalysisElementData.)
| Attribute | Gets the attribute.
| AttributeHierarchies | Gets the supported attribute hierarchies for the current instance.
| Caption | Gets or sets the caption. (Inherited from AnalysisElementData.)
| Category | Gets the potential analysis category for the current instance. (Inherited from ElementData.)
| CompatibleUniqueName | Gets the compatible unique name. This property allows grouping together compatible hierarchies across multiple IAnalysisStructures.
| Containers | Gets the container objects used alter the presentation of the elements using a folder-like approach. (Inherited from ElementData.)
| Description | Gets or sets the description. (Inherited from ElementData.)
| EntityId | Gets the parent entity ID. (Inherited from ElementData.)
| HasAttributeHierarchies | Gets a value indicating whether this instance has attribute hierarchies defined within.
| HierarchyCategory | Gets the current instance hierarchy category.
| IsAnonymized | Gets a value indicating whether the hierarchy members are to be anonymized during data retrieval operations, for legal or security reasons.
| IsHidden | Gets a value indicating whether this instance is hidden and therefore not present in the parent cube hierarchy collection.
| IsHierarchy | Gets a value indicating whether this instance is a hierarchy. (Inherited from AnalysisElementData.)
| IsMeasure | Gets a value indicating whether this instance is a measure. (Inherited from AnalysisElementData.)
| IsTimeHierarchy | Gets a value indicating whether this instance is a time hierarchy.
| Levels | Gets the hierarchy levels.
| Links | Gets the links between the hierarchy entity and the DataCube output connector elements.
| Parameters | Gets the public parameter collection, if the hierarchy either exposes inherited parameters or if it allows parameter definition.
| Properties | Gets the various uncategorized properties. (Inherited from ElementData.)
| SecurityAttributeId | Gets the security attribute ID, if one is associated with the current hierarchy.
| SortPolicy | Gets the sorting behavior defined for the hierarchy.
| SupportedAggregators | Gets or sets the supported aggregators. (Inherited from AnalysisElementData.)
| TimeProviderFirstDayOfWeek | Gets the time provider for the current instance.
| TimeProviderId | Gets the time provider for the current instance.
| UIClassName | Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)
| UniqueName | Gets the object unique name. (Inherited from UniqueNameData.)

Top
Methods

| Name | Description
--- | --- | ---
| FromDataContractMappings | The mapping between the DTO and the business object.
| ToDataContractMappings | The mapping between the business object and the DTO.
| ToDataContractMappingsWithAttributeHierarchies | The mapping between the business object and the DTO with attribute hierarchies.

Top
See Also

#### Reference

Dundas.BI.WebApi.Models Namespace