Class

PageReference

 The page reference for an index topic.

QuickLinks

extractLabel, insertLabel, remove

Hierarchy

Topic

PageReference

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	Long ParagraphStyle	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.
pageReferenceType	PageReferenceType: PageReferenceType.CURRENT_PAGE PageReferenceType.TO_NEXT_STYLE_CHANGE PageReferenceType.TO_NEXT_USE_OF_STYLE PageReferenceType.TO_END_OF_STORY PageReferenceType.TO_END_OF_DOCUMENT PageReferenceType.TO_END_OF_SECTION PageReferenceType.FOR_NEXT_N_PARAGRAPHS PageReferenceType.FOR_NEXT_N_PAGES PageReferenceType.SUPPRESS_PAGE_NUMBERS	r/w	Options for index page references.
parent	Topic	readonly	The parent of the PageReference (a Topic).
parentStory	Story	readonly	The story that contains the text.
properties	Object	r/w	A property that allows setting of several properties at the same time.
storyOffset	number	readonly	The index of the character containing the table (from the beginning of the story).

Methods

Instances

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

Parameter	Type	Description
key	string	The key.

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.

Return

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

Jongware, 27-Jun-2010 v3.0.3d

Contents :: Index