Class Member

Represents a single member within a hierarchy, tuple, level, or member.

Inheritance
System.Object
Member
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Olap.Data
Assembly: Syncfusion.Olap.Base.dll
Syntax
public class Member : IDisposable
Remarks

A member is an item in a hierarchy that represents one or more records in the underlying relational database. A member is the lowest level of reference used when accessing cell data in a cube.

Members are used to construct tuples, which in turn are used to construct sets. Members are organized hierarchically; a member can have other members associated with it. For example, in a time dimension that contains three levels named Year, Month, and Day, the members of the Day level are leaf members because they have no child members. The members in the Year and Month levels are non-leaf members, because each member in the Month level has at least 28 child members from the Day level and each member in the Year level has 12 child members from the Month level.

The member encapsulates the information necessary to describe a member, including a collection of member objects that contain child members, if applicable.

The information available to a member depends on the parent of the collection of members from which the member was retrieved. While the members collection externally represents a collection of member objects for a specified Hierarchy, Tuple, Level, or Member, the collection is internally loaded and managed in one of two ways, depending on the parent of the Hierarchy, Tuple, Level, or Member:

* If the parent object was referenced through a CubeSchema in order to retrieve meta-data from the server, then the collection represents the members that are defined for the parent object.

* If the parent object was referenced through a CellSet in order to retrieve meta-data from a query, then the collection represents the members that are retrieved for the set (or axis) that contains the parent object.

Constructors

Member()

Initializes a new instance of the Member class.

Declaration
public Member()

Properties

Caption

Gets or sets the caption of the member.

Declaration
public string Caption { get; set; }
Property Value
Type Description
System.String

The caption of the member.

ChildMembers

Gets or sets the collection of child members.

Declaration
public MemberCollection ChildMembers { get; }
Property Value
Type Description
MemberCollection

The collection of child members.

CubeSchema

Gets or sets the cube schema.

Declaration
public CubeSchema CubeSchema { get; set; }
Property Value
Type Description
CubeSchema

The cube schema.

CustomUniqueName

Gets the custom unique name of the member.

Declaration
public string CustomUniqueName { get; }
Property Value
Type Description
System.String

The custom unique name of the member.

Description

Gets or sets the description of the member.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

The description of the member.

DrilledDown

Gets or sets a value indicating whether the member is drilled down.

Declaration
public bool DrilledDown { get; set; }
Property Value
Type Description
System.Boolean

HasChildMembers

Gets or sets a value indicating whether the member has child members.

Declaration
public bool HasChildMembers { get; set; }
Property Value
Type Description
System.Boolean

IsMemberLoadedOnDemand

Gets a value indicating whether the member is loaded on demand.

Declaration
public bool IsMemberLoadedOnDemand { get; }
Property Value
Type Description
System.Boolean

KPIStatusGraphic

Gets or sets the KPI status graphic value.

Declaration
public string KPIStatusGraphic { get; set; }
Property Value
Type Description
System.String

The KPI status graphic value.

KPITrendGraphic

Gets or sets the KPI trend graphic value.

Declaration
public string KPITrendGraphic { get; set; }
Property Value
Type Description
System.String

The KPI trend graphic value.

KPIType

Gets or sets the type of the KPI.

Declaration
public KpiTypeEnum KPIType { get; set; }
Property Value
Type Description
KpiTypeEnum

The type of the KPI.

LevelDepth

Gets or sets the level depth of the member.

Declaration
public int LevelDepth { get; set; }
Property Value
Type Description
System.Int32

The level depth of the member.

LevelUniqueName

Gets or sets the unique name of the level.

Declaration
public string LevelUniqueName { get; set; }
Property Value
Type Description
System.String

MemberProperties

Gets or sets the collection of member properties.

Declaration
public PropertyCollection MemberProperties { get; set; }
Property Value
Type Description
PropertyCollection

The collection of member properties.

Name

Gets or sets the name of the member.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name of the member object

ParentCaption

Gets or sets the caption of the parent object.

Declaration
public string ParentCaption { get; set; }
Property Value
Type Description
System.String

The caption of parent object.

ParentCustomUniqueName

Gets the custom unique name of the parent object.

Declaration
public string ParentCustomUniqueName { get; }
Property Value
Type Description
System.String

The custom unique name of the parent object.

ParentDimension

Gets or sets the parent dimension.

Declaration
public string ParentDimension { get; set; }
Property Value
Type Description
System.String

The parent dimension.

ParentHierarchy

Gets or sets the parent hierarchy.

Declaration
public string ParentHierarchy { get; set; }
Property Value
Type Description
System.String

The parent hierarchy.

ParentLevel

Gets or sets the parent level of the member.

Declaration
public Level ParentLevel { get; set; }
Property Value
Type Description
Level

The parent level of the member.

ParentMember

Gets or sets the parent member.

Declaration
public Member ParentMember { get; set; }
Property Value
Type Description
Member

The parent member.

ParentUniqueName

Gets or sets the unique name of the parent object.

Declaration
public string ParentUniqueName { get; set; }
Property Value
Type Description
System.String

The parent unique name as string.

Properties

Gets or sets the collection of properties.

Declaration
public PropertyCollection Properties { get; }
Property Value
Type Description
PropertyCollection

The collection of properties.

Type

Gets or sets the type of the member.

Declaration
public MemberTypeEnum Type { get; set; }
Property Value
Type Description
MemberTypeEnum

The type of the member.

UniqueName

Gets or sets the unique name of the member.

Declaration
public string UniqueName { get; set; }
Property Value
Type Description
System.String

The unique name of the member.

Visible

Gets or sets a value indicating whether this Member is visible.

Declaration
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

GetDimension()

Gets the dimension.

Declaration
public Dimension GetDimension()
Returns
Type Description
Dimension

The Dimension object

GetDimension(CubeSchema)

Gets the dimension.

Declaration
public Dimension GetDimension(CubeSchema cubeSchema)
Parameters
Type Name Description
CubeSchema cubeSchema

The cube schema.
Returns
Type Description
Dimension

The dimension object if matches, else returns null

ToString()

Returns a System.String that represents the current System.Object.

Declaration
public override string ToString()
Returns
Type Description
System.String

A System.String that represents the current System.Object.
Overrides
System.Object.ToString()

Implements

System.IDisposable

Extension Methods