Class DimensionElement

Represents a dimension object in the cube.

Inheritance

System.Object

Element

DimensionElement

Implements

ICloneable<Element>

ICloneable<DimensionElement>

Inherited Members

Element.ElementName

Element.Name

Element.Properties

Element.RootNodeCaption

Element.Visible

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Olap.Reports

Assembly: Syncfusion.Olap.Base.dll

Syntax

public class DimensionElement : Element, ICloneable<Element>, ICloneable<DimensionElement>

Remarks

DimensionElement is created in OlapReport object and added into the collection.

Constructors

DimensionElement()

Initializes a new instance of the DimensionElement class.

Declaration

public DimensionElement()

Properties

DrillState

Gets or sets the drill state.

Declaration

public DrillState DrillState { get; set; }

Property Value

Type
DrillState

DrillUpDownLevel

Gets or sets the level name till which expand/collapse operation needs to be done. NOTE: This would be enabled only when DrillState option is set to "ExpandToLevel"/"CollapseToLevel".

Declaration

public string DrillUpDownLevel { get; set; }

Property Value

Type
System.String

DrillUpDownMember

Gets or sets the member name from which expand/collapse operation needs to be done. NOTE: This would be enabled only when DrillState option is set to "ExpandToLevel"/"CollapseToLevel" and "DrillUpDownLevel" pointing to which level the expand/collapse operation needs to be done.

Declaration

public string DrillUpDownMember { get; set; }

Property Value

Type
System.String

Hierarchy

Gets or sets the hierarchy element based on the hierarchy name.

Declaration

public HierarchyElement Hierarchy { get; set; }

Property Value

Type	Description
HierarchyElement	The hierarchy element.

HierarchyName

Gets or sets the name of the hierarchy.

Declaration

public string HierarchyName { get; set; }

Property Value

Type	Description
System.String	The name of the hierarchy.

MemberProperties

Gets or sets the collection of member properties.

Declaration

public MemberPropertyCollection MemberProperties { get; set; }

Property Value

Type	Description
MemberPropertyCollection	The collection of member properties.

UniqueName

Gets or sets the unique name of the hierarchy.

Declaration

public string UniqueName { get; }

Property Value

Type	Description
System.String	The unique name of the hierarchy.

Methods

AddLevel(String, String)

Adds the level to the existing hierarchy.

Declaration

public bool AddLevel(string hierarchyName, string levelName)

Parameters

Type	Name	Description
System.String	hierarchyName	The name of the hierarchy.
System.String	levelName	The name of the level.

Returns

Type	Description
System.Boolean	true if the level is added; otherwise, false.

AddMember(String, MemberElement)

Adds the member to the level element.

Declaration

public bool AddMember(string levelName, MemberElement memberElement)

Parameters

Type	Name	Description
System.String	levelName	The name of the level.
MemberElement	memberElement	The member element.

Returns

Type	Description
System.Boolean	true if added to the level; otherwise, false.

AddMember(String, String)

Adds the member to the specified level.

Declaration

public bool AddMember(string levelName, string memberName)

Parameters

Type	Name	Description
System.String	levelName	The name of the level.
System.String	memberName	The name of the member.

Returns

Type	Description
System.Boolean	true if the member is added to the level; otherwise, false.

AddMembers(String, String[])

Adds the array of members to the level.

Declaration

public bool AddMembers(string levelName, params string[] memberNames)

Parameters

Type	Name	Description
System.String	levelName	The name of the level.
System.String[]	memberNames	The member names.

Returns

Type	Description
System.Boolean	true the if members are added to the level; otherwise, false.

Clone()

Clones this instance.

Declaration

public DimensionElement Clone()

Returns

Type	Description
DimensionElement	A copy of this instance.

Implements

ICloneable<T>

ICloneable<T>