pagination
pagination
Provides the functionality to paginate through a recordset
Metadata
Attributes
| Name |
Type |
Required |
Default |
Options |
Description |
| query |
string |
No |
|
|
A query name that contains the objectids to loop over. |
| array |
string |
No |
|
|
An array of objectids to loop over. Can be used instead of query. |
| typename |
string |
No |
|
|
|
| paginationID |
string |
No |
fcPagination |
|
Uniquely identifies this pagination set. Set if using sticky pages or if multiple pagination sets on a single page. |
| bStickyPages |
string |
No |
false |
|
Keeps track of the page the user is currently on in session against this key. |
| currentPage |
string |
No |
0 |
|
|
| actionURL |
string |
No |
|
|
|
| r_stObject |
string |
No |
stObject |
|
The name of the calling page structure that will contain the current row of the recordset as struct |
| totalRecords |
string |
No |
0 |
|
The total number of records in the records. Used if only the current page of the recordset was passed in. 0 assumes that the recordset passed in is the entire recordset to be paginated. |
| maxRecordsToDisplay |
numeric |
No |
0 |
|
|
| pageLinks |
numeric |
No |
10 |
|
|
| recordsPerPage |
numeric |
No |
10 |
|
|
| submissionType |
string |
No |
url |
|
|
| Step |
numeric |
No |
1 |
|
|
| top |
boolean |
No |
true |
|
|
| bottom |
boolean |
No |
true |
|
|
| oddRowClass |
string |
No |
oddrow |
|
The class name returned in stobjects for each "even" current row |
| evenRowClass |
string |
No |
evenrow |
|
The class name returned in stobjects for each "odd" current row |
| bDisplayTotalRecords |
string |
No |
0 |
|
display the total records or not |
| linksWebskin |
string |
No |
displayLinks |
|
webskin to use for rendering the pagination scroll |
| r_pageLinksHtml |
string |
No |
|
|
Save page links html to a variable so we can return it to the caller |