Syntax 1 For DataWindow controls and child DataWindows

Description

Scrolls a DataWindow control forward one page, displaying the next group of rows in the DataWindow's display area. (A page is the number of rows that can be displayed in the DataWindow control at one time.) ScrollNextPage changes the current row, but not the current column.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control, DataWindowChild object


Syntax

PowerBuilder

long dwcontrol.ScrollNextPage ( )

Argument

Description

dwcontrol

A reference to a DataWindow control or child DataWindow


Return value

Returns the number of the row displayed at the top of the DataWindow control when the scroll finishes or tries to scroll past the last row. ScrollNextPage returns 1 with nested or composite reports and child DataWindows since, in these cases, the current row cannot be changed. ScrollNextPage returns -1 if an error occurs.

If dwcontrol is null, in PowerBuilder and JavaScript the method returns null.

Usage

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

For an example that uses RowCount and Describe to check whether the user has scrolled to the last page, see RowCount.

Events

ScrollNextPage can trigger these events:

ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging

Examples

This statement scrolls dw_employee forward one page:

dw_employee.ScrollNextPage()

See also

Scroll

ScrollFirstPage

ScrollLastPage

ScrollNextRow

ScrollPriorPage

ScrollPriorRow

ScrollToRow

SelectRow