Collection of Spread

Spreads

A collection of spreads.

Properties

Name	Type	Access	Description
	Number	readonly	The number of objects in the collection.

Methods

→ Spread

Returns the Spread with the specified index.

index Number The index.

→ Spread

Creates a new spread.

at? LocationOptions The location of the spread relative to the reference object or within the document.

reference? Spread | Document The reference object. Note: Required when the at parameter specifies before or after. Can accept: Spread or Document.

withProperties? Object Initial values for properties of the new Spread

→ Spread

Returns any Spread in the collection.

→ Number

Displays the number of elements in the Spread.

→ Spread[]

Returns every Spread in the collection.

→ Spread

Returns the first Spread in the collection.

→ Spread

Returns the Spread with the specified index or name.

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

→ Spread

Returns the Spread with the specified ID.

id Number The ID.

→ Spread

Returns the Spread with the specified name.

name String The name.

→ Spread[]

Returns the Spreads within the specified range.

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

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

→ Spread

Returns the last Spread in the collection.

→ Spread

Returns the middle Spread in the collection.

→ Spread

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

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

→ Spread

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

obj Spread The index of the Spread that follows the desired Spread.

→ String

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

Object of 1

Properties elsewhere that hold a Spreads.

Document.spreads