ERPConnect.BW.HierarchyCollection

Namespace: ERPConnect.BW
Assembly: ERPConnectStandard20.dll

This collecton class represents a set of hierarchy objects

public class HierarchyCollection : CollectionBase, IList, ICollection, IEnumerable

Inheritance

object ← CollectionBase ← HierarchyCollection

Implements

IList, ICollection, IEnumerable

Inherited Members

CollectionBase.Clear(), CollectionBase.RemoveAt(int), CollectionBase.GetEnumerator(), CollectionBase.OnSet(int, object, object), CollectionBase.OnInsert(int, object), CollectionBase.OnClear(), CollectionBase.OnRemove(int, object), CollectionBase.OnValidate(object), CollectionBase.OnSetComplete(int, object, object), CollectionBase.OnInsertComplete(int, object), CollectionBase.OnClearComplete(), CollectionBase.OnRemoveComplete(int, object), CollectionBase.InnerList, CollectionBase.List, CollectionBase.Capacity, CollectionBase.Count, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

HierarchyCollection()

Constructs a new HierarchyCollection object

public HierarchyCollection()

Properties

this[int]

Returns an hierarchy object of a given position

public virtual Hierarchy this[int Index] { get; set; }

Property Value

Hierarchy

this[string]

Returns a Hierarchy object by its name

public virtual Hierarchy this[string UniqueName] { get; set; }

Property Value

Hierarchy

Methods

Add(Hierarchy)

Adds an existing Hierarchy object to the collection

public virtual void Add(Hierarchy NewParameter)

Parameters

NewParameter Hierarchy

The Hierarchy object to be added

Add(Dimension, string, string, string)

Adds a new Hierarchy object to the collection

public virtual Hierarchy Add(Dimension Dimension, string Name, string UniqueName, string Caption)

Parameters

Dimension Dimension

Reference to a Dimension object

Name string

Name of the hierarchy

UniqueName string

Unique name of the hierarchy

Caption string

A brief description text

Returns

Hierarchy

The hierarchy object that was created and added to the collection

ContainsHierarchy(string)

Detects if the hierarchy with a given name is contained in the collection

public bool ContainsHierarchy(string HierarchyName)

Parameters

HierarchyName string

The name of the hierarchy to be looked up for

Returns

bool

true / false depending if the hierarchy is already added to the collection

Insert(int, Hierarchy)

Inserts an existing Hierarchy object to the collection

public virtual void Insert(int Index, Hierarchy NewParameter)

Parameters

Index int

Oridnal number of the position

NewParameter Hierarchy

The Hierarchy object to be added

TryGetValue(string, out Hierarchy)

public bool TryGetValue(string uniqueName, out Hierarchy value)

Parameters

uniqueName string

value Hierarchy

Returns

bool