ERPConnect.BW.BWVariable

Namespace: ERPConnect.BW
Assembly: ERPConnectStandard20.dll

A cube's variable

public class BWVariable

Inheritance

object ← BWVariable

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

BWVariable()

Constructs a new BWVariable object

public BWVariable()

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

Constructs a new BWVariable object

public BWVariable(BWCube cube, string name, string caption, string dataType, bool isRequired, BWVariableSelectionType selectionType, string referenceDimension, 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

isRequired bool

Defines if this variable is obligatory or not

selectionType BWVariableSelectionType

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

referenceDimension string

Defines which dimension this variable refers to

type BWVariableType

Defines if the variable is numeric, member or hierarchy

Properties

Caption

Caption or description of the variable

public string Caption { get; set; }

Property Value

string

ComplexRanges

Represents a collection of ranges when the selection type is complex

public RangeCollection ComplexRanges { get; set; }

Property Value

RangeCollection

Cube

Reference to the cube the variable is belonging to

public BWCube Cube { get; set; }

Property Value

BWCube

DataType

DataType of the variable

public string DataType { get; set; }

Property Value

string

Name

Name of the variable

public string Name { get; set; }

Property Value

string

ReferenceDimensionName

Defines which dimension this variable refers to

public string ReferenceDimensionName { get; set; }

Property Value

string

Required

Defines if this variable is obligatory or not

public bool Required { get; set; }

Property Value

bool

SelectionType

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

public BWVariableSelectionType SelectionType { get; set; }

Property Value

BWVariableSelectionType

SingleRange

Represents a single range when the selection type is interval or single

public Range SingleRange { get; set; }

Property Value

Range

Type

Defines if the variable is numeric, member or hierarchy

public BWVariableType Type { get; set; }

Property Value

BWVariableType

Methods

GetMembers(int, int)

Returns all members of this variable (can be used for designing a value help)

public MembersDataTable GetMembers(int StartRow, int EndRow)

Parameters

StartRow int

The row number the selection starts with

EndRow int

The row number the selection ends with

Returns

MembersDataTable

A DataTable that contains the members

ToString()

Converts this object to string

public override string ToString()

Returns

string

The string