PageReference

The page reference for an index topic. For information, see topics.

Properties

Property	Type	Access	Description
id	number	readonly	The unique ID of the PageReference.
index	number	readonly	The index of the PageReference within its containing object.
label	string	r/w	A property that can be set to any string.
pageNumberStyleOverride	CharacterStyle	r/w	The character style applied to page numbers.
pageReferenceLimit	any	r/w	The paragraph style or number of paragraphs or pages that defines the last page in a page range. Note: Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can return: ParagraphStyle or Long Integer.
pageReferenceType	PageReferenceType : CURRENT_PAGE TO_NEXT_STYLE_CHANGE TO_NEXT_USE_OF_STYLE TO_END_OF_STORY TO_END_OF_DOCUMENT TO_END_OF_SECTION FOR_NEXT_N_PARAGRAPHS FOR_NEXT_N_PAGES SUPPRESS_PAGE_NUMBERS	r/w	The page number for an index page reference or the last page in a page range.
parent	Topic	readonly	The parent of the PageReference (a Topic).
properties	Object	r/w	A property that allows setting of several properties at the same time.
sourceText	Text	readonly	The hyperlinked text or insertion point.

Methods

string extractLabel (key:
string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of PageReferencegetElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the PageReference.

string toSource ()
Generates a string which, if executed, will return the PageReference.

string toSpecifier ()
Retrieves the object specifier.

Used in:

PageReferences.previousItem (

obj:
PageReference )

PageReferences.nextItem (

obj:
PageReference )

Returned by:

Array of PageReference PageReference .getElements (

)

PageReference PageReferences.add (
source:
Text[, pageReferenceType:
PageReferenceType=CURRENT_PAGE ][, pageReferenceLimit:
any][, pageNumberStyleOverride:
CharacterStyle][, withProperties:
Object]
)

PageReference PageReferences.anyItem (

)

Array of PageReference PageReferences.everyItem (

)

PageReference PageReferences.firstItem (

)

PageReference PageReferences.item (
index:
any
)

PageReference PageReferences.itemByID (
id:
number
)

PageReference PageReferences.itemByName (
name:
string
)

Array of PageReference PageReferences.itemByRange (
from:
any, to:
any
)

PageReference PageReferences.lastItem (

)

PageReference PageReferences.middleItem (

)

PageReference PageReferences.nextItem (
obj:
PageReference
)

PageReference PageReferences.previousItem (
obj:
PageReference
)