O4WTablePageOptions Function
Description
Specifies pagination and sorting options for table contents. When specified, the default pagination subroutine will be applied to the current table (unless <overridePager> is set to the name of a different pagination subroutine to use).
Syntax
O4WTABLEPAGEROPTIONS(pagerLocn,rowsPerPage,sortCols,maxRows,currPage,addlOptions,overridePager)
Parameters
The function has the following parameters:
| Parameter | Description | |
|---|---|---|
| pagerLocn | The parameter should be set to "0" to have the pagination display appear above the table, and "1" to appear below the table. | |
| rowsPerPage | Set to the number of rows/page that should initially be displayed. | |
| sortCols | Contains an @VM-delimited list of the column numbers where sorting should be allowed (the first column of the table is "1", the second column is "2", etc.). | |
| maxRows | If known, maxRows should be set to the total number of rows to be displayed in the table. | |
| currPage | The currPage parameter should be set to the current page number ("1" initially, and then as appropriate after any callbacks for pagination/sorting have been handled). | |
| addlOptions | Any additional options needed by the pagination routine should be passed with the addlOptions parameter. | |
| overridePager | The name of a pagination subroutine to be used when applying page options to the table. | |
Returns
Returns the option information to use immediately with a display element or input control.