GetCurrGridIndex

Top  Previous  Next

Gets the index of current active grid - either the full gird or a sub grid.

[Visual Basic .NET]

Public Function GetCurrGridIndex() As Integer

[C#]

public int GetCurrGridIndex();

Parameters

None.

 

Return Value:

The return value is the index of current active grid.

(1) If the full grid is active, the return value is -1.

GetCurrGridIndex_1

 

(2) For cascade mode, the return value is -2.

GetCurrGridIndex_2

 

(3) For a active sub grid in cascade mode, the return value is between 0 and the return value of GetTotalSubGrids() minus 1. For example, the return value is 2 for the following case.

GetCurrGridIndex_3