Adobe InCopy CS5 (7.0) Object Model JS: DocumentEvent

InCopy CS5

Class

DocumentEvent

 A document event. Base Class: Event

QuickLinks

getElements, preventDefault, stopPropagation, toSource, toSpecifier

Hierarchy

Application | Document
Event
DocumentEvent
MutationEvent

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.
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.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
r/wControls the display of dialogs and alerts during script processing.

Class

PropertyTypeAccessDescription
AFTER_CLOSEstring readonlyDispatched after a Document is closed. This event bubbles. This event is not cancelable. (default: afterClose)
AFTER_NEWstring readonlyDispatched after a Document is created. This event bubbles. This event is not cancelable. (default: afterNew)
AFTER_OPENstring readonlyDispatched after a Document is opened. This event bubbles. This event is not cancelable. (default: afterOpen)
AFTER_REVERTstring readonlyDispatched after a Document is reverted. This event bubbles. This event is not cancelable. (default: afterRevert)
AFTER_SAVEstring readonlyDispatched after a Document is saved. This event bubbles. This event is not cancelable. (default: afterSave)
AFTER_SAVE_ASstring readonlyDispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable. (default: afterSaveAs)
AFTER_SAVE_A_COPYstring readonlyDispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable. (default: afterSaveACopy)
BEFORE_CLOSEstring readonlyDispatched before a Document is closed. This event bubbles. This event is not cancelable. (default: beforeClose)
BEFORE_NEWstring readonlyDispatched before a Document is created. This event bubbles. This event is cancelable. (default: beforeNew)
BEFORE_OPENstring readonlyDispatched before a Document is opened. This event bubbles. This event is cancelable. (default: beforeOpen)
BEFORE_REVERTstring readonlyDispatched before a Document is reverted. This event bubbles. This event is cancelable. (default: beforeRevert)
BEFORE_SAVEstring readonlyDispatched before a Document is saved. This event bubbles. This event is cancelable. (default: beforeSave)
BEFORE_SAVE_ASstring readonlyDispatched before a Document is saved under a new name. This event bubbles. This event is cancelable. (default: beforeSaveAs)
BEFORE_SAVE_A_COPYstring readonlyDispatched before a copy of a Document is saved. This event bubbles. This event is cancelable. (default: beforeSaveACopy)

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, 23-Mar-2011 v3.0.3dContents :: Index