InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

PageReference

The page reference for an index topic.

Hierarchy

Topic

PageReference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the PageReference.
Number readonly The index of the PageReference within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the PageReference; this is an alias to the PageReference's label property.
CharacterStyle read/write The character style applied to page numbers.
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
 read/write Options for index page references.
Topic readonly The parent of the PageReference (a Topic).
Object read/write A property that allows setting of several properties at the same time.
Text readonly The hyperlinked text or insertion point.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ PageReference[]

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

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the PageReference.

→ Boolean

Removes the event listener.

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.
→ String

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

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a PageReference.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a PageReference.

PageReferences.itemByRange(from)PageReferences.nextItem(obj)PageReferences.previousItem(obj)

Return 14

Methods that return a PageReference.

PageReference.getElements()PageReferences.[]()PageReferences.add()PageReferences.anyItem()PageReferences.everyItem()PageReferences.firstItem()PageReferences.item()PageReferences.itemByID()PageReferences.itemByName()PageReferences.itemByRange()PageReferences.lastItem()PageReferences.middleItem()PageReferences.nextItem()PageReferences.previousItem()