K4 InDesign Javascript API Documentation

BasicsEvents

A collection of events.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

anyItem(
)
  → Event
count(
)
  → number
everyItem(
)
  → Event
firstItem(
)
  → Event
item(
index)
  → Event
itemByID(
id)
  → Event
itemByRange(
from, to)
  → Event
lastItem(
)
  → Event
middleItem(
)
  → Event
nextItem(
obj)
  → Event
previousItem(
obj)
  → Event
toSource(
)
  → string
anyItem(
)
  → Event
Returns any Event in the collection.
count(
)
  → number
Displays the number of elements in the Event.
everyItem(
)
  → Event
Returns every Event in the collection.
firstItem(
)
  → Event
Returns the first Event in the collection.
item(
index)
  → Event
Returns the Event with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Event
Returns the Event with the specified ID.
id number The ID.
itemByRange(
from, to)
  → Event
Returns the Events within the specified range.
from The Event, index, or name at the beginning of the range. Can accept: Event, Long Integer or String.
to The Event, index, or name at the end of the range. Can accept: Event, Long Integer or String.
lastItem(
)
  → Event
Returns the last Event in the collection.
middleItem(
)
  → Event
Returns the middle Event in the collection.
nextItem(
obj)
  → Event
Returns the Event whose index follows the specified Event in the collection.
obj Event The Event whose index comes before the desired Event.
previousItem(
obj)
  → Event
Returns the Event with the index previous to the specified index.
obj Event The index of the Event that follows the desired Event.
toSource(
)
  → string
Generates a string which, if executed, will return the Event.