ScrollPriorRow

Description

Scrolls to the prior instance of the document in a RichTextEdit control or RichTextEdit DataWindow. A RichTextEdit control has multiple instances of its document when it shares data with a DataWindow. The next instance of the document is associated with the next row in the DataWindow.

For syntax specific to DataWindow controls and child DataWindows, see the ScrollPriorRow method for DataWindows in the section called “ScrollPriorRow” in DataWindow Reference.

Applies to

DataWindow and RichTextEdit controls

Syntax

rtename.ScrollPriorRow ( )

Argument

Description

rtename

The name of the RichTextEdit or DataWindow control in which you want to scroll to the prior document instance. Each instance is associated with a DataWindow row.

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


Return value

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.

ScrollPriorRow goes to the prior instance of the RichTextEdit document. In contrast, repeated calls to ScrollPriorPage pages back through all the pages of the document instance and then back to the pages for the prior row.

Examples

This statement scrolls to the prior instance of the document in the RichTextEdit control rte_1. Each document instance is associated with a row of data.

rte_1.ScrollPriorRow()

See also

Scroll

ScrollNextPage

ScrollNextRow

ScrollPriorPage