ERPConnect.BW.DimensionCollection
Namespace: ERPConnect.BW
Assembly: ERPConnectStandard20.dll
A collection of BWDimension objects
Inheritance
object ← CollectionBase ← DimensionCollection
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
DimensionCollection()
Constructs a new DimensionCollection object
Properties
this[int]
Returns a BWDimension object at a given position
Property Value
this[string]
Returns a BWDimension object for a given name
Property Value
Methods
Add(Dimension)
Adds an existing BWDimension object to the collection
Parameters
NewParameter Dimension
The BWDimension object to be added
Add(R3Connection, BWCube, string, string, string, string, DimensionType)
Creates a new BWDimension object and adds it to the collection
public virtual Dimension Add(R3Connection Connection, BWCube Cube, string Name, string UniqueName, string Description, string Caption, DimensionType Type)
Parameters
Connection R3Connection
A valid connection object
Cube BWCube
A BWCube object
Name string
The name of the dimension
UniqueName string
The unique name of the dimension
Description string
The description of the dimension
Caption string
The caption of the dimension
Type DimensionType
The type of the dimension (measure, normal or time)
Returns
The BWDimension object that is created and added to the collection
Add(R3Connection, BWCube, string, string, string, string, DimensionType, string, int)
Creates a new BWDimension object and adds it to the collection
public virtual Dimension Add(R3Connection Connection, BWCube Cube, string Name, string UniqueName, string Description, string Caption, DimensionType Type, string DataType, int Decimals)
Parameters
Connection R3Connection
A valid connection object
Cube BWCube
A BWCube object
Name string
The name of the dimension
UniqueName string
The unique name of the dimension
Description string
The description of the dimension
Caption string
The caption of the dimension
Type DimensionType
The type of the dimension (measure, normal or time)
DataType string
The data type of the dimension (e.g. CHAR)
Decimals int
The number of decimals digits (if the DataType is DEC)
Returns
The BWDimension object that is created and added to the collection
ContainsDimension(string)
Detects if the diemnsion with a given name is contained in the collection
Parameters
DimensionName string
The name of the dimension to be looked up for
Returns
true / false depending if the dimension is already added to the collection
Insert(int, Dimension)
Inserts an existing BWDimension object to the collection
Parameters
Index int
The index where the object should be added at
NewParameter Dimension
The BWDimension object to be added
Remove(string)
Parameters
DimensionName string
TryGetValue(string, out Dimension)
Parameters
uniqueName string
value Dimension