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) |
|
A RichTextEdit DataWindow to view the prior page within the document (PowerBuilder only) |
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.
DataWindow type |
Method applies to |
|---|---|
PowerBuilder |
DataWindow control, DataWindowChild object |
Web |
Client control |
Web ActiveX |
DataWindow control, DataWindowChild object |
long dwcontrol.ScrollPriorPage ( )
Web DataWindow client control and Web ActiveX
number dwcontrol.ScrollPriorPage ( )
Argument |
Description |
|---|---|
dwcontrol |
The name of the DataWindow control or child DataWindow you want to page (scroll) to the prior page |
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.
ScrollPriorPage does not highlight the current row. Use SelectRow to let the user know what row is current.
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 DeleteRow 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.
ScrollPriorPage can trigger these events:
ItemChanged
ItemError
ItemFocusChanged
RowFocusChanged
RowFocusChanging
This statement scrolls dw_employee backward one page:
dw_employee.ScrollPriorPage()
Scrolls to the prior page of the document in a RichTextEdit DataWindow.
DataWindow type |
Method applies to |
|---|---|
PowerBuilder |
DataWindow control |
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. |
Returns 1 if it succeeds and –1 if an error occurs.
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 ScrollPriorPage in the PowerScript
Reference.
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()
