GetFirstVisibleColumn Method

Returns an integer value which represents the column index of the first currently visible column within the DataGrid object.

DataGridObject.GetFirstVisibleColumn()

Client support

   Newlook Smartclient only.

Use

This method takes into account the current horizontal scrolling position of the DataGrid and can be used to determine what columns in the grid are visible at any point in time. If a column is only partially visible it will not be returned.

For a grid with 10 columns if a user had scrolled to the right and only the last 8 columns were showing, the first visible column would now be the 3rd one, in which case this method would return 2 (column indexes are zero based).

Columns which have been saved with their Visible property set to False are included within the returned index (but will never have their index returned since they wont be visible). eg. in the above example, if column 1 had its visibility set to False (hence their were only 9 visible columns), this method would still return 2 if the last 8 columns were currently within view.

Arguments

None.

Returns

This method returns an integer value representing the column index of the first visible column.

ClosedExample

The following example saves the index of the first visible column as a newlook variable:

JSCRIPT:

function ReturnFirstColumn()

{

firstVisibleCol = App.ActiveForm.TestGrid.GetFirstVisibleColumn;

App.SetValue ("FirstVisibleColIndex", firstVisibleCol);

}

Applies To

DataGrid control

See Also

GetFirstVisibleRowMethod

© 2004-2021 looksoftware. All rights reserved.