ScrollPriorPage

Scrolls to the prior page in a DataWindow control.

To scroll

Use

To the prior group of rows in a DataWindow (when the DataWindow does not have the RichTextEdit presentation style)

Syntax 1

A RichTextEdit DataWindow to view the prior page within the document (PowerBuilder only)

Syntax 2


Syntax 1 For DataWindow controls and child DataWindows

Description

Scrolls a DataWindow control backward one page, displaying another 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.) ScrollPriorPage 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.ScrollPriorPage ( )

Argument

Description

dwcontrol

The name of the DataWindow control or child DataWindow you want to page (scroll) to the prior page


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 first row. ScrollPriorPage returns -1 if an error occurs.

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

Usage

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

Events

ScrollPriorPage can trigger these events:

ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging

Examples

This statement scrolls dw_employee backward one page:

dw_employee.ScrollPriorPage()

See also

Scroll

ScrollFirstPage

ScrollLastPage

ScrollNextPage

ScrollNextRow

ScrollPriorRow

ScrollToRow

SelectRow

Syntax 2 For RichTextEdit DataWindows

Description

Scrolls to the prior page of the document in a RichTextEdit DataWindow.

Applies to

DataWindow type

Method applies to

PowerBuilder

DataWindow control


Syntax

PowerBuilder

integer rtename.ScrollPriorPage ( )

Argument

Description

rtename

The name of the DataWindow control in which you want to scroll to the prior page.

The DataWindow object in the DataWindow control must be a RichTextEdit DataWindow.


Return value

Returns 1 if it succeeds and -1 if an error occurs.

Usage

A RichText DataWindow contains multiple instances of the document, one instance for each row. When the first page of the document for one row is visible, calling ScrollPriorPage goes to the last page for the prior row.

PowerBuilder RichTextEdit control

You can use the same syntax with any PowerBuilder RichTextEdit control. See the section called “ScrollPriorPage” in PowerScript Reference.

Examples

This statement scrolls to the prior page of the RichText document in the DataWindow control dw_rpt. If there are multiple instances of the document, it can scroll to the prior instance:

dw_rpt.ScrollPriorPage()

See also

Scroll

ScrollNextPage

ScrollNextRow

ScrollPriorRow