ERPConnect.BW.BWVariableCollection

Namespace: ERPConnect.BW
Assembly: ERPConnectStandard20.dll

A class that holds a set of BWVariable objects

public class BWVariableCollection : CollectionBase, IList, ICollection, IEnumerable

Inheritance

object ← CollectionBase ← BWVariableCollection

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

BWVariableCollection()

Constructs a new BWVariableCollection object

public BWVariableCollection()

Properties

this[int]

Returns the BWVariable object at a given index

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

Property Value

BWVariable

this[string]

Returns the BWVariable object with the given name

public virtual BWVariable this[string Name] { get; set; }

Property Value

BWVariable

Methods

Add(BWVariable)

Adds a new BWVariable object to the collection

public virtual void Add(BWVariable NewParameter)

Parameters

NewParameter BWVariable

A new BWVariable object

Add(BWCube, string, string, string, bool, BWVariableSelectionType, string, BWVariableType)

Adds a new BWVariable object to the collection

public virtual BWVariable Add(BWCube Cube, string Name, string Caption, string DataType, bool Required, BWVariableSelectionType SelectionType, string ReferenceDimensionName, BWVariableType Type)

Parameters

Cube BWCube

Reference to the cube the variable is belonging to

Name string

Name of the variable

Caption string

Caption or description of the variable

DataType string

DataType of the variable

Required bool

Defines if this variable is obligatory or not

SelectionType BWVariableSelectionType

Defines the type of the variable (complex, single or interval)

ReferenceDimensionName string

Defines which dimension this variable refers to

Type BWVariableType

Defines if the variable is numeric, member or hierarchy

Returns

BWVariable

The new BWVariable object

Insert(int, BWVariable)

Insert a BWVariable object into the collection at a given index

public virtual void Insert(int Index, BWVariable NewParameter)

Parameters

Index int

The ordinal number where the BWVariable object is to be inserted at

NewParameter BWVariable

The BWVariable object to be inserted

Remove(string)

public virtual void Remove(string Name)

Parameters

Name string

ToString()

Converts the object to a string

public override string ToString()

Returns

string

The string

TryGetValue(string, out BWVariable)

public bool TryGetValue(string name, out BWVariable value)

Parameters

name string

value BWVariable

Returns

bool