GetVisibleIndexes

 Top  Previous  Next

Gets the attributes of the visible area for the grid in readonly - either the full gird or a sub grid.

[Visual Basic .NET]

Public Function GetVisibleIndexes(ByVal GridIndex As Integer,

                                                  ByRef SectionStart As Integer,

                                                  ByRef RowStart As Integer,

                                                  ByRef ColumnStart As Integer

                                                  ByRef SectionEnd As Integer,

                                                  ByRef RowEnd As Integer,

                                                  ByRef ColumnEnd As Integer) As Boolean

[C#]

public bool GetVisibleIndexes(int GridIndex,

                                            ref int SectionStart,

                                            ref int RowStart,

                                            ref int ColumnStart,

                                            ref int SectionEnd,

                                            ref int RowEnd,

                                            ref int ColumnEnd);

Parameters

GridIndex

Specifies the grid index - either the full gird or a sub grid. -1 indicates the full grid; for a sub grid, the parameter's value must be between 0 and the return value of GetTotalSubGrids() minus 1.

SectionStart

Points to a variable holding the section index (0-based) of the first visible row. If the AllowSections is set to FALSE, this parameter becomes irrelevant.

RowStart

Points to a variable holding the index (0-based) of the first visible row.

ColumnStart

Points to a variable holding the index (0-based) of the first visible column.

SectionEnd

Points to a variable holding the section index (0-based) of the last visible row. If the AllowSections is set to FALSE, this parameter becomes irrelevant.

RowEnd

Points to a variable holding the index (0-based) of the last visible row.

ColumnEnd

Points to a variable holding the index (0-based) of the last visible column.

 

 

 

Return Value:

If the operation is successful, it returns TRUE; otherwise it returns FALSE.