TDecisionSource.GetActiveDim Method

Converts a row-specific or column-specific dimension index into an absolute dimension index.

Pascal

function GetActiveDim(dimGroup: TDimGroup; index: Integer; bOpen: Boolean): Integer;

C++

__fastcall int GetActiveDim(TDimGroup dimGroup, int index, Boolean bOpen);

Description

Call GetActiveDim to obtain the index of a dimension in the decision cube from its position in a decision grid. The names and values of row dimensions appear in the label cells on the right of the decision grid. The first row dimension appears in the first column, the second row dimension appears in the second column, and so on. Similarly, column dimensions appear in the label cells on the top of the decision grid, with the first column dimension appearing in the first row of the grid.

The dimGroup parameter indicates whether the dimension of interest is a row dimension or column dimension. If dimGroup is dgRow, the dimension is a row dimension. If dimGroup is dgCol, the dimension is a column dimension. GetActiveDim is only implemented for dimGroup values of dgRow and dgCol.

The Index parameter indicates the position of the dimension in the set of row or column dimensions, where 0 specifies the first row or column dimension, 1 specifies the second dimension, and so on.

The bOpen parameter specifies whether closed dimensions are counted when interpreting Index. Only open dimensions are counted when bOpen is true.

GetActiveDim returns the absolute index of the dimension. Absolute indexes are used by many methods of the decision source, such as GetDimensionName or GetMemberAsString.

Note: To obtain a row-specific index or column-specific index from an absolute dimension index, use the GetIndex method.