PageReference

Methods:

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CharacterStyle, EventListeners, Events, Number, Object, PageReferenceType, ParagraphStyle, String, Text,

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	Number	readonly	The unique ID of the PageReference.
index	Number	readonly	The index of the PageReference within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the PageReference; this is an alias to the PageReference's label property.
pageNumberStyleOverride	CharacterStyle	read/write	The character style applied to page numbers.
pageReferenceLimit	ParagraphStyle LongInteger	read/write	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 PageReferenceType.CURRENT_PAGE PageReferenceType.FOR_NEXT_N_PAGES PageReferenceType.FOR_NEXT_N_PARAGRAPHS PageReferenceType.SUPPRESS_PAGE_NUMBERS PageReferenceType.TO_END_OF_DOCUMENT PageReferenceType.TO_END_OF_SECTION PageReferenceType.TO_END_OF_STORY PageReferenceType.TO_NEXT_STYLE_CHANGE PageReferenceType.TO_NEXT_USE_OF_STYLE	read/write	Options for index page references.
parent	Topic	readonly	The parent of the PageReference (a Topic).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sourceText	Text	readonly	The hyperlinked text or insertion point.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

PageReference getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined remove ()

Deletes the PageReference.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)