Post Pagination Script API
The table below lists the functions and objects that are only available in Post Pagination Scripts. Click through to the object to find a description and sample scripts.
See Post Pagination Scripts for information about this kind of scripts, how to insert them and what you can do with them.
Note: Post Pagination Scripts only apply to the Print context. These functions and objects cannot be used with other contexts.
Tip: It is possible to define a function in a Control Script which calls these functions, as long as that function is only invoked from a Post Pagination Script.
Object or function | Usage |
---|---|
merge.context.query(selector) | Call merge.context.query(selector) to run a query across all sections in the Print context. |
merge.section.paginate() | A call to merge.section.paginate() triggers pagination of the current section. Note: section is assumed to refer to a variable that holds a Section object (see Retrieving a section). |
merge.section.pagination |
Used to get the total page count, sheet count and start/end page numbers for a single section. See Pagination. Note: |
merge.pagination |
Used to get the total page count, sheet count and start/end page numbers for all sections in the Print context after pagination. See Pagination. |
PaginationInfo | This object contains essential information about one element in order to create a table of contents (see Creating a Table Of Contents). |
results.info() | A call to results.info() returns pagination information (see PaginationInfo) for the first element in the result set of a query (see query(selector)). |
Other objects that are available to Post Pagination Scripts
The list above isn't exhaustive: the objects listed in the Designer API (see Standard Script API) and in the Control Script API (see Control Script API) are also available in Post Pagination Scripts.