InDesign Server2025
API 20.5.0.49
Collection of CrossReference

CrossReferences

A collection of index cross references. (For cross references in text, use the 'cross reference source' and 'hyperlink' objects.)

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

CrossReference

Returns the CrossReference with the specified index.

index Number The index.
CrossReference

Creates a new cross reference.

referencedTopic Topic The topic that the cross reference points to.
crossReferenceType CrossReferenceType The cross reference type.
customTypeString? String The custom string to use in the cross reference. Valid only for custom cross reference types.
withProperties? Object Initial values for properties of the new CrossReference
CrossReference

Returns any CrossReference in the collection.

Number

Displays the number of elements in the CrossReference.

CrossReference[]

Returns every CrossReference in the collection.

CrossReference

Returns the first CrossReference in the collection.

CrossReference

Returns the CrossReference with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
CrossReference

Returns the CrossReference with the specified ID.

id Number The ID.
CrossReference

Returns the CrossReference with the specified name.

name String The name.
CrossReference[]

Returns the CrossReferences within the specified range.

from CrossReference | LongInteger | String The CrossReference, index, or name at the beginning of the range. Can accept: CrossReference, Long Integer or String.
to CrossReference | LongInteger | String The CrossReference, index, or name at the end of the range. Can accept: CrossReference, Long Integer or String.
CrossReference

Returns the last CrossReference in the collection.

CrossReference

Returns the middle CrossReference in the collection.

CrossReference

Returns the CrossReference whose index follows the specified CrossReference in the collection.

obj CrossReference The CrossReference whose index comes before the desired CrossReference.
CrossReference

Returns the CrossReference with the index previous to the specified index.

obj CrossReference The index of the CrossReference that follows the desired CrossReference.
String

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

Object of 1

Properties elsewhere that hold a CrossReferences.