MasterSpreads

A collection of master spreads.

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

MasterSpread [] (index:Number)

Returns the MasterSpread with the specified index.

Parameter

Type

Description

index

Number

The index.

MasterSpread add (pagesPerSpread:Number, withProperties:Object)

Creates a new master spread.

Parameter

Type

Description

pagesPerSpread

Number

The number of pages to include in the master spread. (Optional)

withProperties

Object

Initial values for properties of the new MasterSpread (Optional)

MasterSpread anyItem ()

Returns any MasterSpread in the collection.

Number count ()

Displays the number of elements in the MasterSpread.

MasterSpread everyItem ()

Returns every MasterSpread in the collection.

MasterSpread firstItem ()

Returns the first MasterSpread in the collection.

MasterSpread item (index:Varies LongInteger String)

Returns the MasterSpread with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

MasterSpread itemByID (id:Number)

Returns the MasterSpread with the specified ID.

Parameter

Type

Description

id

Number

The ID.

MasterSpread itemByName (name:String)

Returns the MasterSpread with the specified name.

Parameter

Type

Description

name

String

The name.

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

Returns the MasterSpreads within the specified range.

Parameter

Type

Description

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 lastItem ()

Returns the last MasterSpread in the collection.

MasterSpread middleItem ()

Returns the middle MasterSpread in the collection.

MasterSpread nextItem (obj:MasterSpread)

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

Parameter

Type

Description

obj

MasterSpread

The MasterSpread whose index comes before the desired MasterSpread.

MasterSpread previousItem (obj:MasterSpread)

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

Parameter

Type

Description

obj

MasterSpread

The index of the MasterSpread that follows the desired MasterSpread.

String toSource ()

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

Object of

Document.masterSpreads