PageReference

An index page reference.

PageReference Properties

Property Type Access Description
id Long read A unique number identifying the object.
index Long read Index of the object within its parent object.
label String r/w A label that can be set to any string.
pageNumberStyleOverride CharacterStyle r/w The style override replacing the standard generation option.
pageReferenceLimit ParagraphStyle, Long r/w The page reference limit as ParagraphStyle or Long.
pageReferenceType PageReferenceType enumeration r/w The page reference type.
parent Object read The parent of the object.
properties An array of property names and values r/w Property that allows setting of several properties at the same time.
sourceText Text read The text where this source is located.

PageReference Methods

Method Returns Description
extractLabel String Gets the content of the label associated with the specified key (name).
getElements Array of Objects Resolve the object specifier.
insertLabel Nothing Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
remove Nothing Delete the object.
toSource String Generate JavaScript source that, if executed, will return the specified objects.
toSpecifier String Retrieve the object specifier.

Leave a Comment

Previous post:

Next post: