InDesign Server2025
API 20.5.0.49
Collection of MasterSpread

MasterSpreads

A collection of master spreads.

Properties

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

Methods

→ MasterSpread

Returns the MasterSpread with the specified index.

index Number The index.
→ MasterSpread

Creates a new master spread.

pagesPerSpread? Number The number of pages to include in the master spread.
withProperties? Object Initial values for properties of the new MasterSpread
→ MasterSpread

Returns any MasterSpread in the collection.

→ Number

Displays the number of elements in the MasterSpread.

→ MasterSpread[]

Returns every MasterSpread in the collection.

→ MasterSpread

Returns the first MasterSpread in the collection.

→ MasterSpread

Returns the MasterSpread with the specified index or name.

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

Returns the MasterSpread with the specified ID.

id Number The ID.
→ MasterSpread

Returns the MasterSpread with the specified name.

name String The name.
→ MasterSpread[]

Returns the MasterSpreads within the specified range.

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

Returns the last MasterSpread in the collection.

→ MasterSpread

Returns the middle MasterSpread in the collection.

→ MasterSpread

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

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

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

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

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

Object of 1

Properties elsewhere that hold a MasterSpreads.