Adobe InDesign CS3 (5.0) Object Model JS: Events

InDesign CS3

Class

Events

 A collection of events.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Event anyItem ()
Returns any Event in the collection.

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

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

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

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

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

Event itemByID (id: number)
Returns the Event with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromEvent
Long Integer
String
The Event, index, or name at the beginning of the range. Can accept: Event, Long Integer or String.
toEvent
Long Integer
String
The Event, index, or name at the end of the range. Can accept: Event, Long Integer or String.

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

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

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

ParameterTypeDescription
objEventThe Event whose index comes before the desired Event.

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

ParameterTypeDescription
objEventThe index of the Event that follows the desired Event.

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

Element of

Application.events

Document.events

Menu.events

MenuAction.events

ScriptMenuAction.events

Submenu.events

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