Adobe InDesign CS2 (4.0) Object Model JS: SynchronizeOptions

InDesign CS2

Class

SynchronizeOptions

 A collection of book synchronization option styles.

QuickLinks

anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

SynchronizeOption anyItem ()
Returns any SynchronizeOption in the collection.

number count ()
Displays the number of elements in the SynchronizeOption.

Array of SynchronizeOption everyItem ()
Returns every SynchronizeOption in the collection.

SynchronizeOption firstItem ()
Returns the first SynchronizeOption in the collection.

SynchronizeOption item (index: any)
Returns the SynchronizeOption with the specified index or name.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long or String.

SynchronizeOption itemByName (name: string)
Returns the SynchronizeOption with the specified name.

ParameterTypeDescription
namestringThe name.

Array of SynchronizeOption itemByRange (from: any, to: any)
Returns the SynchronizeOptions within the specified range.

ParameterTypeDescription
fromLong
String
SynchronizeOption
The SynchronizeOption, index, or name at the beginning of the range. Can accept: SynchronizeOption, Long or String.
toLong
String
SynchronizeOption
The SynchronizeOption, index, or name at the end of the range. Can accept: SynchronizeOption, Long or String.

SynchronizeOption lastItem ()
Returns the last SynchronizeOption in the collection.

SynchronizeOption middleItem ()
Returns the middle SynchronizeOption in the collection.

SynchronizeOption nextItem (obj: SynchronizeOption)
Returns the SynchronizeOption whose index follows the specified SynchronizeOption in the collection.

ParameterTypeDescription
objSynchronizeOptionThe SynchronizeOption whose index comes before the desired SynchronizeOption.

SynchronizeOption previousItem (obj: SynchronizeOption)
Returns the SynchronizeOption with the index previous to the specified index.

ParameterTypeDescription
objSynchronizeOptionThe index of the SynchronizeOption that follows the desired SynchronizeOption.

string toSource ()
Generates a string which, if executed, will return the SynchronizeOption.

Element of

Book.synchronizeOptions

Jongware, 27-Jun-2010 v3.0.3dContents :: Index