DataGrid.getDisplayIndex

Overview | Methods | Fields | This Package | All Packages

DataGrid.getDisplayIndex

Retrieves the display index of the row associated with the specified bookmark.

Syntax

public int getDisplayIndex( Object bookmark )

Parameters

bookmark

The bookmark associated with the row.

Return Value

Returns the zero-based display index of the row. If the specified row is not currently visible, then -1 is returned.

Exceptions

WFCInvalidArgumentException thrown if the DataGrid control is not bound.

Remarks

A row's display index indicates the order in which it is displayed in the grid's current scroll position. The topmost visible row has a display index of 0.