2022.2

Object or func-
tion
Usage
merge.section.pagination Usedtogetthetotalpagecount,sheetcountandstart/endpagenumbersforasinglesection.See"Pagination"
onpage855.Note:sectionisassumedtorefertoavariablethatholdsaSectionobject(see"Retrievingasec-
tion"onpage848).
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"onpage857.
"PaginationInfo"onpage843 Thisobjectcontainsessentialinformationaboutoneelementinordertocreateatableofcontents(see"Creatinga
TableOfContents"onpage411).
results."info()"onpage847 Acalltoresults.info()returnspaginationinformation(see"PaginationInfo"onpage843)forthefirstelementintheresult
setofaquery(see"query(selector)"onpage843).
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"on
page715)andintheControlScriptAPI(see"ControlScriptAPI"onpage815)arealsoavailablein
PostPaginationScripts.
contentitem
ThecontentitemobjectholdsthePrintContentItemthatwillbewrittentotheConnectdatabase
whengeneratingPrintoutput.
ItspropertiesfieldallowstoaddcustompropertiestothePrintContentItem,intheformofkey-
valuepairs(aJSONstring).
Thecontentitemobjectcanbeusedinanytypeofscript.However,ifyouwanttoaddproduction
information-suchasthepage,size,andpositionofelementsafterpagination-totheproperties,
youhavetowriteaPostPaginationScript(see"PostPaginationScripts"onpage410).
Field Type Description
properties
Properties Key-valuepairscontainingcustomproperties.
Notethatapropertyvalueisalwaysstoredasastringinthedatabase.
Example
Thisfollowingcodewouldaddapropertycalled'myProperty'withthevalue'myvalue':
contentitem.properties.myProperty = 'myvalue';
Youcanreplace'myProperty'and'myvalue'withwhatevernameandvaluebestsuitstheusecase.
Page 840