HierarchyUsage Class

Class that encapsulates the query details associated with a hierarchy.

Inheritance Hierarchy

SystemObject
Dundas.BI.Entities.MetricSetsAnalysisElementUsage
Dundas.BI.Entities.MetricSetsHierarchyUsage

Namespace: Dundas.BI.Entities.MetricSets
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)

Syntax

C++

Copy

public class HierarchyUsage : AnalysisElementUsage

Public Class HierarchyUsage
	Inherits AnalysisElementUsage

public ref class HierarchyUsage : public AnalysisElementUsage

type HierarchyUsage = 
    class
        inherit AnalysisElementUsage
    end

The HierarchyUsage type exposes the following members.

Properties

	Name	Description
	AnalysisElement	Gets the parent IAnalysisElement. (Inherited from AnalysisElementUsage)
	Caption	Gets or sets the usage element caption. (Inherited from AnalysisElementUsage)
	Expression	Gets the script expression, if the usage element is based on a CalculatedHierarchy.
	Hierarchy	Gets the underlying hierarchy.
	IsAxisHierarchy	Gets a value indicating whether this instance is an axis hierarchy.
	IsExcludedFromDataExport	Gets or sets a value indicating whether this element is exported in non-image exports. (Inherited from AnalysisElementUsage)
	IsHierarchy	Gets a value indicating whether this instance is a hierarchy. (Inherited from AnalysisElementUsage)
	IsMeasure	Gets a value indicating whether this instance is a measure. (Inherited from AnalysisElementUsage)
	IsTimeHierarchy	Gets a value indicating whether this instance is a time hierarchy. (Inherited from AnalysisElementUsage)
	IsUnknownMemberCaptionBlank	Gets or sets a value indicating whether the unknown member caption is blank or not.
	LevelParameter	Gets the associated hierarchy level parameter for a column or row hierarchy.
	MetricSet	Gets the parent entity. (Inherited from AnalysisElementUsage)
	Parameter	Gets the associated data parameter. (Inherited from AnalysisElementUsage)
	Placement	Gets the element placement. (Inherited from AnalysisElementUsage)
	RetrieveAllMemberOnly	Gets or sets a value indicating whether all of this hierarchy's values should be collapsed into a single All Member when displayed.
	RetrieveUnknownMembers	Gets or sets a value indicating whether unknown members should be retrieved or not. (Inherited from AnalysisElementUsage)
	ShownTotals	Gets or sets how the totals are displayed for the current instance.
	SortPolicy	Gets the sorting behavior for the hierarchy.
	TargetHierarchyParameter	Gets the associated dynamic hierarchy parameter, when the underlying hierarchy is a dynamic hierarchy.
	TimeHierarchy	Gets the time hierarchy, if the base analysis element is a time hierarchy. Otherwise the property returns .
	UniqueName	Gets the unique name of the underlying analysis element. (Overrides AnalysisElementUsageUniqueName)
	UnknownMemberCaption	Gets or sets the override for the unknown member caption.

Top

Methods

	Name	Description
	ReplaceUniqueName	Replaces the unique name for the current hierarchy usage. When the current instance references a calculated hierarchy, its name is also changed accordingly.

Top

Reference

Dundas.BI.Entities.MetricSets Namespace