Adobe InDesign CS4 (6.0) Object Model JS: DocumentEvent

InDesign CS4

Class

DocumentEvent

 A document event. Base Class: Event

QuickLinks

getElements, preventDefault, stopPropagation, toSource, toSpecifier

Hierarchy

Application | Document
Event
DocumentEvent

Properties

PropertyTypeAccessDescription
bubblesbool readonlyIf true, the event supports the bubbling phase of propagation.
cancelablebool readonlyIf true, the default behavior of the event on its target can be canceled.
capturesbool readonlyIf true, the event supports the capturing phase of propagation.
currentTargetObject readonlyThe current propagation target of the event.
defaultPreventedbool readonlyIf true, the default behavior of the event on its target has been canceled.
eventPhaseEventPhases:
EventPhases.NOT_DISPATCHING
EventPhases.CAPTURING_PHASE
EventPhases.AT_TARGET
EventPhases.BUBBLING_PHASE
EventPhases.DONE
readonlyThe current propagation phase of the event.
eventTypestring readonlyThe name of the event.
fullNameFile readonlyThe full path to the DocumentEvent, including the name of the DocumentEvent.
idnumber readonlyThe unique ID of the DocumentEvent.
indexnumber readonlyThe index of the DocumentEvent within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication
Document
readonlyThe parent of the DocumentEvent (a Application or Document).
propagationStoppedbool readonlyIf true, propagation of the event beyond the current target has been stopped.
propertiesObject r/wA property that allows setting of several properties at the same time.
targetObject readonlyThe target of the event.
timeStampDate readonlyThe time the event was initialized.
userInteractionLevelUserInteractionLevels:
UserInteractionLevels.NEVER_INTERACT
UserInteractionLevels.INTERACT_WITH_ALL
UserInteractionLevels.INTERACT_WITH_ALERTS
readonlyControls the display of dialogs and alerts during script processing.

Methods

Instances

Array of DocumentEvent getElements ()
Resolves the object specifier, creating an array of object references.

void preventDefault ()
Cancels the default behavior of the event on its target.

void stopPropagation ()
Stops propagation of the event beyond the current target.

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

string toSpecifier ()
Retrieves the object specifier.

Return

Array of DocumentEvent DocumentEvent.getElements ()

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