ScrollToRow

Description

Scrolls a DataWindow control to the specified row. ScrollToRow changes the current row but not the current column.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataWindowChild object


Syntax

PowerBuilder

integer dwcontrol.ScrollToRow ( long row )

Argument

Description

dwcontrol

A reference to a DataWindow control or child DataWindow.

row

A value identifying the row to which you want to scroll. If row is 0, ScrollToRow scrolls to the first row. If row is greater than the last row number, it scrolls to the last row. If row is visible without scrolling, the DataWindow does not scroll.


Return value

Returns the number of the row to which the DataWindow scrolls if it succeeds and -1 if an error occurs.

If any argument's value is null, in PowerBuilder and JavaScript the method returns null.

Usage

After you call ScrollToRow, the specified row becomes the new current row. If that row is already visible, the displayed rows do not change. If the row is not visible, the displayed rows change to display the row.

ScrollToRow does not highlight the row. Use SelectRow to let the user know what row is current.

Events

ScrollToRow can trigger these events:

ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged

Examples

This statement scrolls to row 10 and makes it current in the DataWindow control dw_employee:

dw_employee.ScrollToRow(10)

See also

Scroll

ScrollNextPage

ScrollNextRow

ScrollPriorPage

ScrollPriorRow

SelectRow