Class
A document event. Base Class: Event getElements, preventDefault, stopPropagation, toSource, toSpecifier
DocumentEvent
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| bubbles | bool | readonly | If true, the event supports the bubbling phase of propagation. |
| cancelable | bool | readonly | If true, the default behavior of the event on its target can be canceled. |
| currentTarget | Object | readonly | The current propagation target of the event. |
| defaultPrevented | bool | readonly | If true, the default behavior of the event on its target has been canceled. |
| eventPhase | EventPhases: EventPhases.NOT_DISPATCHING EventPhases.AT_TARGET EventPhases.BUBBLING_PHASE EventPhases.DONE |
readonly | The current propagation phase of the event. |
| eventType | string | readonly | The name of the event. |
| fullName | File | readonly | The full path to the DocumentEvent, including the name of the DocumentEvent. |
| id | number | readonly | The unique ID of the DocumentEvent. |
| index | number | readonly | The index of the DocumentEvent within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | Application Document |
readonly | The parent of the DocumentEvent (a Application or Document). |
| propagationStopped | bool | readonly | If true, propagation of the event beyond the current target has been stopped. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| target | Object | readonly | The target of the event. |
| timeStamp | Date | readonly | The time the event was initialized. |
| userInteractionLevel | UserInteractionLevels: UserInteractionLevels.NEVER_INTERACT UserInteractionLevels.INTERACT_WITH_ALL UserInteractionLevels.INTERACT_WITH_ALERTS |
r/w | Controls the display of dialogs and alerts during script processing. |
Class
| Property | Type | Access | Description |
|---|---|---|---|
| AFTER_CLOSE | string | readonly | Dispatched after a Document is closed. This event bubbles. This event is not cancelable. (default: afterClose) |
| AFTER_NEW | string | readonly | Dispatched after a Document is created. This event bubbles. This event is not cancelable. (default: afterNew) |
| AFTER_OPEN | string | readonly | Dispatched after a Document is opened. This event bubbles. This event is not cancelable. (default: afterOpen) |
| AFTER_REVERT | string | readonly | Dispatched after a Document is reverted. This event bubbles. This event is not cancelable. (default: afterRevert) |
| AFTER_SAVE | string | readonly | Dispatched after a Document is saved. This event bubbles. This event is not cancelable. (default: afterSave) |
| AFTER_SAVE_AS | string | readonly | Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable. (default: afterSaveAs) |
| AFTER_SAVE_A_COPY | string | readonly | Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable. (default: afterSaveACopy) |
| BEFORE_CLOSE | string | readonly | Dispatched before a Document is closed. This event bubbles. This event is not cancelable. (default: beforeClose) |
| BEFORE_NEW | string | readonly | Dispatched before a Document is created. This event bubbles. This event is cancelable. (default: beforeNew) |
| BEFORE_OPEN | string | readonly | Dispatched before a Document is opened. This event bubbles. This event is cancelable. (default: beforeOpen) |
| BEFORE_REVERT | string | readonly | Dispatched before a Document is reverted. This event bubbles. This event is cancelable. (default: beforeRevert) |
| BEFORE_SAVE | string | readonly | Dispatched before a Document is saved. This event bubbles. This event is cancelable. (default: beforeSave) |
| BEFORE_SAVE_AS | string | readonly | Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable. (default: beforeSaveAs) |
| BEFORE_SAVE_A_COPY | string | readonly | Dispatched 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, 20-Jun-2010 v3.0.3d | Contents :: Index |