InDesign Server2025
API 20.5.0.49
Collection of Note

Notes

A collection of notes.

Properties

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

Methods

→ Note

Returns the Note with the specified index.

index Number The index.
→ Note

Creates a new note.

at? LocationOptions The location relative to the reference object or within the containing object.
reference? Note | InsertionPoint The reference object. Note: Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint.
withProperties? Object Initial values for properties of the new Note
→ Note

Returns any Note in the collection.

→ Number

Displays the number of elements in the Note.

→ Note[]

Returns every Note in the collection.

→ Note

Returns the first Note in the collection.

→ Note

Returns the Note with the specified index or name.

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

Returns the Note with the specified ID.

id Number The ID.
→ Note

Returns the Note with the specified name.

name String The name.
→ Note[]

Returns the Notes within the specified range.

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

Returns the last Note in the collection.

→ Note

Returns the middle Note in the collection.

→ Note

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

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

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

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

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

Object of 14

Properties elsewhere that hold a Notes.