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