ScrollPriorPage PowerScript function
Description
Scrolls to the prior page of the document in a RichTextEdit
control or RichTextEdit DataWindow.
For syntax specific to DataWindow controls
and child DataWindows, see the ScrollPriorPage method
for DataWindows in the DataWindow Reference or the online Help.
Controls
DataWindow and RichTextEdit controls
Syntax
|
1 |
<span>rtename</span>.<span>ScrollPriorPage</span> ( ) |
|
Argument |
Description |
|---|---|
|
rtename |
The name of the RichTextEdit or DataWindow The DataWindow object in the DataWindow control must be a RichTextEdit |
Return Values
Integer. Returns 1 if it succeeds and
-1 if an error occurs.
Usage
When the RichTextEdit shares data with a DataWindow, the RichTextEdit 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.
ScrollNextPage and ScrollPriorPage work
in the RichTextEdit control edit mode only when the HeaderFooter
property of a rich text control is selected. They work in print
preview mode regardless of the HeaderFooter property setting and
they work for the RichText DataWindow control in edit mode whether
or not the DataWindow has header or footer bands.
Examples
This statement scrolls to the prior page of the document
in the RichTextEdit control rte_1.
If there are multiple instances of the document, it can scroll to
the prior instance:
|
1 |
rte_1.<span>ScrollPriorPage</span>() |