DocumentEvent

A document event.

Methods:

getElements, preventDefault, stopPropagation, toSource, toSpecifier

Objects:

Boolean, Date, EventPhases, File, Number, Object, String, UserInteractionLevels

Hierarchy:

Superclass: Event

Class: DocumentEvent

Property Listing

Property

Type

Access

Description

bubbles

Boolean

readonly

If true, the event supports the bubbling phase of propagation.

cancelable

Boolean

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

Boolean

readonly

If true, the default behavior of the event on its target has been canceled.

eventPhase

EventPhases

EventPhases.AT_TARGET

EventPhases.BUBBLING_PHASE

EventPhases.DONE

EventPhases.NOT_DISPATCHING

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

Boolean

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

Boolean

readonly

If true, propagation of the event beyond the current target has been stopped.

properties

Object

read/write

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.INTERACT_WITH_ALERTS

UserInteractionLevels.INTERACT_WITH_ALL

UserInteractionLevels.NEVER_INTERACT

read/write

Controls the display of dialogs and alerts during script processing.

Constants/Events

Name

Type

Access

Description

AFTER_CLOSE

String

readonly

Dispatched after a Document is closed. This event bubbles. This event is not cancelable.

AFTER_NEW

String

readonly

Dispatched after a Document is created. This event bubbles. This event is not cancelable.

AFTER_OPEN

String

readonly

Dispatched after a Document is opened. This event bubbles. This event is not cancelable.

AFTER_REVERT

String

readonly

Dispatched after a Document is reverted. This event bubbles. This event is not cancelable.

AFTER_SAVE

String

readonly

Dispatched after a Document is saved. This event bubbles. This event is not cancelable.

AFTER_SAVE_AS

String

readonly

Dispatched after a Document is saved under a new name. This event bubbles. This event is not cancelable.

AFTER_SAVE_A_COPY

String

readonly

Dispatched after a copy of a Document is saved. This event bubbles. This event is not cancelable.

BEFORE_CLOSE

String

readonly

Dispatched before a Document is closed. This event bubbles. This event is not cancelable.

BEFORE_NEW

String

readonly

Dispatched before a Document is created. This event bubbles. This event is cancelable.

BEFORE_OPEN

String

readonly

Dispatched before a Document is opened. This event bubbles. This event is cancelable.

BEFORE_REVERT

String

readonly

Dispatched before a Document is reverted. This event bubbles. This event is cancelable.

BEFORE_SAVE

String

readonly

Dispatched before a Document is saved. This event bubbles. This event is cancelable.

BEFORE_SAVE_AS

String

readonly

Dispatched before a Document is saved under a new name. This event bubbles. This event is cancelable.

BEFORE_SAVE_A_COPY

String

readonly

Dispatched before a copy of a Document is saved. This event bubbles. This event is cancelable.

Method Listing

DocumentEvent getElements ()

Resolves the object specifier, creating an array of object references.

undefined preventDefault ()

Cancels the default behavior of the event on its target.

undefined 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.

Object of

MutationEvent.parent

Return

DocumentEvent.getElements()