PaginationInfo
The PaginationInfo object is returned by the info()
function of the results
object (see info() and results). It contains information about where an element is located: on which page and which sheet, and the total number of pages and sheets in the page bundle in which the element is located.
A page bundle is a group of sections for which the Restart page numbering option is turned off. In other words, page numbering continues from the start of the first section to the end of the last section in the group. (See Configuring page numbers and Control Script: Page numbering.)
The PaginationInfo object (as well as the info()
function) is only available in Post Pagination Scripts (see Post Pagination Scripts). It is essential in a Post Pagination Script that creates a table of contents, as described in the following topic: Creating a Table Of Contents.
For the total page count, sheet count and start/end page numbers of a single section, use the section
object's Pagination (see also: section).
For the total page and sheet count of all Print sections together use the merge
object's Pagination (see also: merge).
Field |
Type |
Description |
---|---|---|
pageCount |
Number |
The number of pages in the page bundle associated with the section in which the first element of the results is located. |
pageNo |
Number |
The page number on which the first element of the results is located. |
Section |
The section in which the element is located. This is always a Print section, since Post Pagination Scripts only operate on the Print context. |
|
sheetCount |
Number |
The number of sheets in the page bundle associated with the section in which the first element of the results is located. |
sheetNo |
Number |
The sheet number on which the first element of the results is located. |