Spreads

A collection of spreads.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

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

Method Listing

Spread [] (index:Number)

Returns the Spread with the specified index.

Parameter	Type	Description
index	Number	The index.

Spread add ([at:LocationOptions=LocationOptions], reference:Varies Spread Document, withProperties:Object)

Creates a new spread.

Parameter	Type	Description
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location of the spread relative to the reference object or within the document. (Optional) (default: LocationOptions.UNKNOWN)
reference	Spread Document	The reference object. Note: Required when the at parameter specifies before or after. Can accept: Spread or Document. (Optional)
withProperties	Object	Initial values for properties of the new Spread (Optional)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the spread relative to the reference object or within the document. (Optional)

(default: LocationOptions.UNKNOWN)

reference

Spread

Document

The reference object. Note: Required when the at parameter specifies before or after. Can accept: Spread or Document. (Optional)

withProperties

Object

Initial values for properties of the new Spread (Optional)

Spread anyItem ()

Returns any Spread in the collection.

Number count ()

Displays the number of elements in the Spread.

Spread everyItem ()

Returns every Spread in the collection.

Spread firstItem ()

Returns the first Spread in the collection.

Spread item (index:Varies LongInteger String)

Returns the Spread with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

Spread itemByID (id:Number)

Returns the Spread with the specified ID.

Parameter	Type	Description
id	Number	The ID.

Spread itemByName (name:String)

Returns the Spread with the specified name.

Parameter	Type	Description
name	String	The name.

Spread itemByRange (from:Varies LongInteger Spread String, to:Varies LongInteger Spread String)

Returns the Spreads within the specified range.

Parameter	Type	Description
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.

Parameter

Type

Description

from

LongInteger

Spread

String

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

LongInteger

Spread

String

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

Spread lastItem ()

Returns the last Spread in the collection.

Spread middleItem ()

Returns the middle Spread in the collection.

Spread nextItem (obj:Spread)

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

Parameter	Type	Description
obj	Spread	The Spread whose index comes before the desired Spread.

Spread previousItem (obj:Spread)

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

Parameter	Type	Description
obj	Spread	The index of the Spread that follows the desired Spread.

String toSource ()

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

Object of

Document.spreads