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.

Controls

DataWindow type	Method applies to
PowerBuilder	DataWindow control, DataWindowChild object
Web	Client control
Web ActiveX	DataWindow control, DataWindowChild object

Syntax

[PowerBuilder]

long <span>dwcontrol</span>.<span>ScrollNextPage</span> ( )

1	long <span>dwcontrol</span>.<span>ScrollNextPage</span> ( )

[Web DataWindow client control and Web ActiveX]

number <span>dwcontrol</span>.<span>ScrollNextPage</span> ( )

1	number <span>dwcontrol</span>.<span>ScrollNextPage</span> ( )

Argument	Description
dwcontrol	A reference to a DataWindow control or child DataWindow

Return Values

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.

Web DataWindow

Calling ScrollNextPage causes the page
to be reloaded with another set of rows from the result set.

If the DataWindow object has retrieval arguments, they must
be specified in the HTMLGen.SelfLinkArgs property. For more information,
see the HTMLGen.property,
the Retrieve method, and the DataWindow Programmers
Guide.

All methods that reload the page perform an AcceptText before
sending data back to the server. If the method fails (returns –1),
this means that pending data changes were not accepted and nothing
was sent back to the server. In this situation the ItemError event
occurs.

Events

ScrollNextPage can trigger these events:

ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging

Examples

This statement scrolls dw_employee forward
one page:

dw_employee.<span>ScrollNextPage</span>()

1	dw_employee.<span>ScrollNextPage</span>()

Syntax 1 For DataWindow controls and child DataWindows – PB Docs 150