InDesign2026
API 21.5.1.73
Collection of PageReference

PageReferences

A collection of index page references.

Properties

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

Methods

PageReference

Returns the PageReference with the specified index.

index Number The index.
PageReference

Creates a new page reference.

source Text The text or insertion point to which the page reference points.
pageReferenceType? PageReferenceType The page number for an index page reference or the last page in an index page reference page range.
pageReferenceLimit? ParagraphStyle | LongInteger The paragraph style or number of paragraphs or pages that defines the last page in a page range. Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can accept: ParagraphStyle or Long Integer.
pageNumberStyleOverride? CharacterStyle The style override for the page number.
withProperties? Object Initial values for properties of the new PageReference
PageReference

Returns any PageReference in the collection.

Number

Displays the number of elements in the PageReference.

PageReference[]

Returns every PageReference in the collection.

PageReference

Returns the first PageReference in the collection.

PageReference

Returns the PageReference with the specified index or name.

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

Returns the PageReference with the specified ID.

id Number The ID.
PageReference

Returns the PageReference with the specified name.

name String The name.
PageReference[]

Returns the PageReferences within the specified range.

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

Returns the last PageReference in the collection.

PageReference

Returns the middle PageReference in the collection.

PageReference

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

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

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

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

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

Object of 1

Properties elsewhere that hold a PageReferences.