Express > Express Assembly Interfaces > IEaxGrid > IEaxGrid.DimRange

IEaxGrid.DimRange

Syntax

DimRange(DimKey: Integer; [LevelIndex: Integer = -1;] [CheckMergedCells: Boolean = false]): ITabRange;

Parameters

DimKey. Dimension key.

LevelIndex. Dimension level.

CheckMergedCells. Indicates whether cells tucking is taken into account.

Description

The DimRange property returns table cell range where elements of the dimension specified by key are shown.

Comments

Available values of the CheckMergedCells parameter:

True. Tucking is taken into account.
False. Tucking is not taken into account. Default value.

The CheckMergedCells parameter affects, for example, on dimension priority on formatting table area of data entry form.

Dimension level is ignored if LevelIndex is set to -1.

To return the table cell range which displays column or row totals, use IEaxGrid.TotalsRange.

Example

Executing the example requires an express report with the EXPRESS identifier that contains a table with column totals. One of the dimensions, which is used to build a table, is a calendar dimension with the 10127 key.

Add links to the Express, Metabase, Tab system assemblies.

Sub UserProc;
Var
    MB: IMetabase;
    Analyzer: IEaxAnalyzer;
    Grid: IEaxGrid;
    DimRange, TotalsRange: ITabRange;
Begin
    MB := MetabaseClass.Active;
    Analyzer := MB.ItemById("EXPRESS").Bind As IEaxAnalyzer;
    Grid := Analyzer.Grid;
    DimRange := Grid.DimRange(10127, -1, False);
    Debug.WriteLine
    ("Address of the cell range, which display dimension elements - " + DimRange.Address);
    TotalsRange := Grid.TotalsRange(True);
    Debug.WriteLine
    ("Address of the cell range, which displays column totals - " + TotalsRange.Address);
End Sub UserProc;

After executing the example the console displays addresses of cells ranges where the following is displayed:

Dimension elements.
Column totals.