BasicsDocumentEvent

A document event.

Extends

Static Properties

Name Description
AFTER_CLOSE = "afterClose" string Dispatched after a Document is closed. This event bubbles. This event is not cancelable.
AFTER_NEW = "afterNew" string Dispatched after a Document is created. This event bubbles. This event is not cancelable.
AFTER_OPEN = "afterOpen" string Dispatched after a Document is opened. This event bubbles. This event is not cancelable.
AFTER_REVERT = "afterRevert" string Dispatched after a Document is reverted. This event bubbles. This event is not cancelable.
AFTER_SAVE = "afterSave" string Dispatched after a Document is saved. This event bubbles. This event is not cancelable.
AFTER_SAVE_AS = "afterSaveAs" string Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.
AFTER_SAVE_A_COPY = "afterSaveACopy" string Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.
BEFORE_CLOSE = "beforeClose" string Dispatched before a Document is closed. This event bubbles. This event is not cancelable.
BEFORE_NEW = "beforeNew" string Dispatched before a Document is created. This event bubbles. This event is cancelable.
BEFORE_OPEN = "beforeOpen" string Dispatched before a Document is opened. This event bubbles. This event is cancelable.
BEFORE_REVERT = "beforeRevert" string Dispatched before a Document is reverted. This event bubbles. This event is cancelable.
BEFORE_SAVE = "beforeSave" string Dispatched before a Document is saved. This event bubbles. This event is cancelable.
BEFORE_SAVE_AS = "beforeSaveAs" string Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.
BEFORE_SAVE_A_COPY = "beforeSaveACopy" string Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.

Instance Properties

Name Description Access
bubbles bool If true, the event supports the bubbling phase of propagation. read-only
cancelable bool If true, the default behavior of the event on its target can be canceled. read-only
currentTarget Object The current propagation target of the event. read-only
defaultPrevented bool If true, the default behavior of the event on its target has been canceled. read-only
eventPhase EventPhases The current propagation phase of the event. read-only
eventType string The name of the event. read-only
fullName File The full path to the DocumentEvent, including the name of the DocumentEvent. read-only
id number The unique ID of the DocumentEvent. read-only
index number The index of the DocumentEvent within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the DocumentEvent (a Application or Document). read-only
propagationStopped bool If true, propagation of the event beyond the current target has been stopped. read-only
properties Object A property that allows setting of several properties at the same time. read-write
target Object The target of the event. read-only
timeStamp Date The time the event was initialized. read-only
userInteractionLevel UserInteractionLevels Controls the display of dialogs and alerts during script processing. read-write

Methods

toSource(
)
 → string
toSpecifier(
)
 → string
getElements(
)
 → DocumentEvent
Resolves the object specifier, creating an array of object references.
preventDefault(
)
Cancels the default behavior of the event on its target.
stopPropagation(
)
Stops propagation of the event beyond the current target.
toSource(
)
 → string
Generates a string which, if executed, will return the DocumentEvent.
toSpecifier(
)
 → string
Retrieves the object specifier.