Adobe InDesign CS6 Server (8.0) Object Model JS: TimingLists

InDesign Server CS6

Class

TimingLists

 A collection of timing lists.

See also TimingList.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

TimingList [] (index: number)
Returns the TimingList with the specified index.

ParameterTypeDescription
indexnumberThe index.

TimingList add (triggerEvent: DynamicTriggerEvents[, withProperties: Object])
Adds a new event-triggered timing list object.

ParameterTypeDescription
triggerEventDynamicTriggerEvents:
DynamicTriggerEvents.ON_PAGE_LOAD
DynamicTriggerEvents.ON_PAGE_CLICK
DynamicTriggerEvents.ON_STATE_LOAD
DynamicTriggerEvents.ON_CLICK
DynamicTriggerEvents.ON_ROLLOVER
DynamicTriggerEvents.ON_RELEASE
DynamicTriggerEvents.ON_ROLLOFF
DynamicTriggerEvents.ON_SELF_CLICK
DynamicTriggerEvents.ON_SELF_ROLLOVER
Trigger Event
withPropertiesObjectInitial values for properties of the new TimingList (Optional)

TimingList anyItem ()
Returns any TimingList in the collection.

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

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

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

TimingList item (index: varies)
Returns the TimingList with the specified index or name.

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

Array of TimingList itemByRange (from: varies, to: varies)
Returns the TimingLists within the specified range.

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

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

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

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

ParameterTypeDescription
objTimingListThe TimingList whose index comes before the desired TimingList.

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

ParameterTypeDescription
objTimingListThe index of the TimingList that follows the desired TimingList.

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

Element of

TimingSetting.timingLists

Jongware, 28-Apr-2012 v3.0.3iContents :: Index