Share via


Hierarchy Class

Definition

Represents a collection of levels that provide a logical hierarchical drilldown path for client applications. It is a child of a Table object.

public sealed class Hierarchy : Microsoft.AnalysisServices.Tabular.NamedMetadataObject, Microsoft.AnalysisServices.Tabular.IMetadataObjectWithLineage
type Hierarchy = class
    inherit NamedMetadataObject
    interface IMetadataObjectWithLineage
Public NotInheritable Class Hierarchy
Inherits NamedMetadataObject
Implements IMetadataObjectWithLineage
Inheritance
Implements

Constructors

Hierarchy()

Create a new instance of the Hierarchy class with default settings.

Properties

Annotations

Gets the collection object of all annotations in the current Hierarchy.

ChangedProperties

Gets the collection object of all changedproperties in the current Hierarchy.

Description

The description of the hierarchy, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

DisplayFolder

Defines the display folder for the hierarchy, for use by clients.

ExtendedProperties

Gets the collection object of all extendedproperties in the current Hierarchy.

HideMembers

Ragged/unbalanced hierarchies can be enabled by hiding members using this property.

IsHidden

A boolean value that indicates whether the hierarchy is treated as hidden by client visualization tools. True if the hierarchy is treated as hidden; otherwise false.

IsRemoved

A Boolean specifying whether this object was removed from an object tree.

(Inherited from MetadataObject)
Levels

Gets the collection object of all levels in the current Hierarchy.

LineageTag

A tag that represents the lineage of the object.

Model

Gets the Tabular model that contains this object.

(Inherited from MetadataObject)
ModifiedTime

The time that the object was last modified.

Name

Gets or Sets the Name of this object.

ObjectType

Gets the type of object.

(Inherited from MetadataObject)
Parent

Parent object, null for Model objects.

RefreshedTime

The time that the object was last refreshed.

SourceLineageTag

A tag that represents the lineage of the source for the object.

State

Provides information on the state of the hierarchy. Possible values and their interpretation are as follows. Ready (1) The hierarchy is queryable and has up-to-date data. NoData (3) Not applicable to Hierarchy. CalculationNeeded (4) The hierarchy does not contain any data because it was not refreshed. There is no error associated with the hierarchy. SemanticError (5) Not applicable to Hierarchy. EvaluationError (6) Not applicable to Hierarchy. DependencyError (7) A dependency associated with the hierarchy is in an error state (SemanticError, EvaluationError, or DependencyError). Incomplete (8) Not applicable to Hierarchy.

StructureModifiedTime

The time that the structure of the object was last modified.

Table

A reference to a Table object that owns this Hierarchy.

Methods

Clone()

Creates a new, full copy of a Hierarchy object.

CopyFrom(Hierarchy)
Obsolete.

Deprecated. Use CopyTo method instead.

CopyTo(Hierarchy)

Copies a Hierarchy object to the specified object.

Rename(String)
Obsolete.

Deprecated. Use RequestRename method instead.

RequestRename(String)

Request rename of this object.

Validate()

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

(Inherited from MetadataObject)

Applies to