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

CrossReference

A cross reference to a different index topic. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

Hierarchy

Topic

CrossReference

Properties

NameType AccessDescription
CrossReferenceType
 read/write The text that precedes or follows the referenced topic.
String read/write The text used for a custom cross reference type. Note: Valid only for custom cross reference types.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the CrossReference.
Number readonly The index of the CrossReference 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 CrossReference; this is an alias to the CrossReference's label property.
Topic readonly The parent of the CrossReference (a Topic).
Object read/write A property that allows setting of several properties at the same time.
Topic read/write The topic to which this CrossReference points.

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.
→ CrossReference[]

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

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

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a CrossReference.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a CrossReference.

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

Return 14

Methods that return a CrossReference.

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