InDesign Server2025
API 20.5.0.49
Collection of Footnote

Footnotes

A collection of footnotes.

Properties

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

Methods

→ Footnote

Returns the Footnote with the specified index.

index Number The index.
→ Footnote

Creates a new footnote.

at? LocationOptions The location of the footnote reference number in the main text relative to the reference object or within the story.
reference? Note | InsertionPoint The reference object. Note: Must be an insertion point or a note. Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint.
withProperties? Object Initial values for properties of the new Footnote
→ Footnote

Returns any Footnote in the collection.

→ Number

Displays the number of elements in the Footnote.

→ Footnote[]

Returns every Footnote in the collection.

→ Footnote

Returns the first Footnote in the collection.

→ Footnote

Returns the Footnote with the specified index or name.

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

Returns the Footnote with the specified ID.

id Number The ID.
→ Footnote

Returns the Footnote with the specified name.

name String The name.
→ Footnote[]

Returns the Footnotes within the specified range.

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

Returns the last Footnote in the collection.

→ Footnote

Returns the middle Footnote in the collection.

→ Footnote

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

obj Footnote The Footnote whose index comes before the desired Footnote.
→ Footnote

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

obj Footnote The index of the Footnote that follows the desired Footnote.
→ String

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

Object of 14

Properties elsewhere that hold a Footnotes.