Class HierarchyCollection

Collection of Hierarchy Objects

Inheritance
System.Object
System.Collections.CollectionBase
HierarchyCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IEnumerable<Hierarchy>
System.Collections.IEnumerable
Inherited Members
System.Collections.CollectionBase.Capacity
System.Collections.CollectionBase.Clear()
System.Collections.CollectionBase.Count
System.Collections.CollectionBase.InnerList
System.Collections.CollectionBase.List
System.Collections.CollectionBase.OnClear()
System.Collections.CollectionBase.OnClearComplete()
System.Collections.CollectionBase.OnInsert(System.Int32, System.Object)
System.Collections.CollectionBase.OnRemove(System.Int32, System.Object)
System.Collections.CollectionBase.OnRemoveComplete(System.Int32, System.Object)
System.Collections.CollectionBase.OnSet(System.Int32, System.Object, System.Object)
System.Collections.CollectionBase.OnValidate(System.Object)
System.Collections.CollectionBase.System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.CollectionBase.System.Collections.ICollection.IsSynchronized
System.Collections.CollectionBase.System.Collections.ICollection.SyncRoot
System.Collections.CollectionBase.System.Collections.IList.Add(System.Object)
System.Collections.CollectionBase.System.Collections.IList.Contains(System.Object)
System.Collections.CollectionBase.System.Collections.IList.get_Item(System.Int32)
System.Collections.CollectionBase.System.Collections.IList.IndexOf(System.Object)
System.Collections.CollectionBase.System.Collections.IList.Insert(System.Int32, System.Object)
System.Collections.CollectionBase.System.Collections.IList.IsFixedSize
System.Collections.CollectionBase.System.Collections.IList.IsReadOnly
System.Collections.CollectionBase.System.Collections.IList.Item[System.Int32]
System.Collections.CollectionBase.System.Collections.IList.Remove(System.Object)
System.Collections.CollectionBase.System.Collections.IList.set_Item(System.Int32, System.Object)
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.Data
Assembly: Syncfusion.Olap.Base.dll
Syntax
public class HierarchyCollection : CollectionBase, IList, ICollection, IEnumerable<Hierarchy>, IEnumerable

Constructors

HierarchyCollection()

Initializes a new instance of the HierarchyCollection class.

Declaration
public HierarchyCollection()

HierarchyCollection(Dimension)

Initializes a new instance of the HierarchyCollection class.

Declaration
public HierarchyCollection(Dimension parent_Dimension)
Parameters
Type Name Description
Dimension parent_Dimension

The parent dimension.

Properties

Item[Int32]

Gets or sets the Hierarchy at the specified index.

Declaration
public Hierarchy this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index

The index of the hierarchy.
Property Value
Type
Hierarchy

Methods

Add(Hierarchy)

Adds the specified hierarchy.

Declaration
public int Add(Hierarchy hierarchy)
Parameters
Type Name Description
Hierarchy hierarchy

The hierarchy which is to be added.
Returns
Type Description
System.Int32

The index of the hierarchy object in the current collection.

Contains(Hierarchy)

Determines whether the collection contains the specified hierarchy.

Declaration
public bool Contains(Hierarchy hierarchy)
Parameters
Type Name Description
Hierarchy hierarchy

The hierarchy object which is to be searched.
Returns
Type Description
System.Boolean

true if it contains the specified hierarchy; otherwise, false.

CopyTo(Hierarchy[], Int32)

Copies all the elements of the current collection to the specified one-dimensional array.

Declaration
public void CopyTo(Hierarchy[] hierarchyArray, int index)
Parameters
Type Name Description
Hierarchy[] hierarchyArray

The one-dimensional array that is the destination of the elements copied from the current array.
System.Int32 index

The index in array at which copying begins.

FindByName(String)

Finds the hierarchy by its name.

Declaration
public Hierarchy FindByName(string name)
Parameters
Type Name Description
System.String name

The name of the hierarchy.
Returns
Type Description
Hierarchy

The hierarchy object.

FindByUniqueName(String)

Finds the hierarchy by its unique name.

Declaration
public Hierarchy FindByUniqueName(string uniqueName)
Parameters
Type Name Description
System.String uniqueName

The unique name of the hierarchy.
Returns
Type Description
Hierarchy

The hierarchy object.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public IEnumerator<Hierarchy> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<Hierarchy>

A System.Collections.Generic.IEnumerator<> that can be used to iterate through the collection.

IndexOf(Hierarchy)

Gets the index of the specified hierarchy.

Declaration
public int IndexOf(Hierarchy hierarchy)
Parameters
Type Name Description
Hierarchy hierarchy

The hierarchy.
Returns
Type Description
System.Int32

The index of the hierarchy in the collection.

Insert(Int32, Hierarchy)

Inserts the hierarchy at specified index.

Declaration
public void Insert(int index, Hierarchy hierarchy)
Parameters
Type Name Description
System.Int32 index

The index at which the hierarchy has to be inserted.
Hierarchy hierarchy

The hierarchy object which is to be inserted.

OnInsertComplete(Int32, Object)

Performs additional custom processes after inserting a new element into the System.Collections.CollectionBase instance.

Declaration
protected override void OnInsertComplete(int index, object value)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which to insert value.
System.Object value

The new value of the element at index.
Overrides
System.Collections.CollectionBase.OnInsertComplete(System.Int32, System.Object)

OnSetComplete(Int32, Object, Object)

Performs additional custom processes after setting a value in the System.Collections.CollectionBase instance.

Declaration
protected override void OnSetComplete(int index, object oldValue, object newValue)
Parameters
Type Name Description
System.Int32 index

The zero-based index at which oldValue can be found.
System.Object oldValue

The value to replace with newValue.
System.Object newValue

The new value of the element at index.
Overrides
System.Collections.CollectionBase.OnSetComplete(System.Int32, System.Object, System.Object)

Remove(Hierarchy)

Removes the specified hierarchy.

Declaration
public void Remove(Hierarchy hierarchy)
Parameters
Type Name Description
Hierarchy hierarchy

The hierarchy object which is to be removed.

RemoveAt(Int32)

Removes the element at the specified index of the System.Collections.CollectionBase instance. This method is not overridable.

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
System.Int32 index

The zero-based index of the element to remove.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

index is less than zero. -or- index is equal to or greater than System.Collections.CollectionBase.Count.

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods