CustomEvent class

Events using the CustomEvent interface can be used to carry custom data.

Inheritance: CustomEvent → Event → DOMObject

The CustomEvent type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of the `CustomEvent` class.

Properties

Property	Description
bubbles	Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false.
cancelable	Used to indicate whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false.
current_target	Used to indicate the `IEventTarget` whose `IEventListener`s are currently being processed. This is particularly useful during capturing and bubbling.
event_phase	Used to indicate which phase of event flow is currently being evaluated.
target	Used to indicate the `IEventTarget` to which the event was originally dispatched.
time_stamp	Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.
type	The name of the event (case-insensitive). The name must be an XML name.
default_prevented	Returns true if preventDefault() was invoked while the cancelable attribute value is true, and false otherwise.
is_trusted	The isTrusted attribute must return the value it was initialized to. When an event is created the attribute must be initialized to false.
NONE_PHASE	Events not currently dispatched are in this phase.
CAPTURING_PHASE	The event is currently being evaluated at the target `IEventTarget`.
AT_TARGET_PHASE	The current event phase is the capturing phase.
BUBBLING_PHASE	The current event phase is the bubbling phase.
detail	Gets the custom data.

Methods

Method	Description
get_platform_type	This method is used to retrieve ECMAScript object Type.
init_event	The `Event.init_event` method is used to initialize the value of an `Event` created through the `IDocumentEvent` interface.
prevent_default	If an event is cancelable, the `Event.prevent_default` method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.
stop_propagation	The `Event.stop_propagation` method is used prevent further propagation of an event during event flow.
stop_immediate_propagation	Invoking this method prevents event from reaching any event listeners registered after the current one and when dispatched in a tree also prevents event from reaching any other objects.
init_custom_event	/// The `Event.init_event` method is used to initialize the value of an `Event` created through the `IDocumentEvent` interface.

CustomEvent class

CustomEvent class

Constructors

Properties

Methods

See Also