K4 InDesign Javascript API Documentation

BasicsEventListeners

A collection of event listeners.

Instance Properties

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

Methods

add(
eventType, handler ​[, captures] ​[, withProperties])
  → EventListener
anyItem(
)
  → EventListener
count(
)
  → number
everyItem(
)
  → EventListener
firstItem(
)
  → EventListener
item(
index)
  → EventListener
itemByID(
id)
  → EventListener
itemByName(
name)
  → EventListener
itemByRange(
from, to)
  → EventListener
lastItem(
)
  → EventListener
middleItem(
)
  → EventListener
nextItem(
obj)
  → EventListener
previousItem(
obj)
  → EventListener
toSource(
)
  → string
add(
eventType, handler ​[, captures=false] ​[, withProperties])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
withProperties Object Initial values for properties of the new EventListener (Optional)
anyItem(
)
  → EventListener
Returns any EventListener in the collection.
count(
)
  → number
Displays the number of elements in the EventListener.
everyItem(
)
  → EventListener
Returns every EventListener in the collection.
firstItem(
)
  → EventListener
Returns the first EventListener in the collection.
item(
index)
  → EventListener
Returns the EventListener with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → EventListener
Returns the EventListener with the specified ID.
id number The ID.
itemByName(
name)
  → EventListener
Returns the EventListener with the specified name.
name string The name.
itemByRange(
from, to)
  → EventListener
Returns the EventListeners within the specified range.
from The EventListener, index, or name at the beginning of the range. Can accept: EventListener, Long Integer or String.
to The EventListener, index, or name at the end of the range. Can accept: EventListener, Long Integer or String.
lastItem(
)
  → EventListener
Returns the last EventListener in the collection.
middleItem(
)
  → EventListener
Returns the middle EventListener in the collection.
nextItem(
obj)
  → EventListener
Returns the EventListener whose index follows the specified EventListener in the collection.
obj EventListener The EventListener whose index comes before the desired EventListener.
previousItem(
obj)
  → EventListener
Returns the EventListener with the index previous to the specified index.
obj EventListener The index of the EventListener that follows the desired EventListener.
toSource(
)
  → string
Generates a string which, if executed, will return the EventListener.