The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

initEvent method

Initializes a new generic event that the createEvent method created.

Important As of Microsoft Edge, the createEvent()/initEvent() constructor pattern for synthetic events is deprecated. See the Synthetic Events page for more information.

Document Object Model (DOM) Level 3 Events Specification, Section 4.1

Syntax

object.initEvent(eventType, canBubble, cancelable)

Parameters

eventType [in]

Type: String

The event type.

canBubble [in]

Type: Boolean

true (true): The event should propagate upward.
false (false): The event does not propagate upward.

cancelable [in]

Type: Boolean

true (true): The default action can be canceled.
false (false): The default action cannot be canceled.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Standards information

Document Object Model (DOM) Level 3 Events Specification, Section 4.1

Remarks

You can call the initEvent method only before the dispatchEvent method dispatches the event object. After the event is dispatched, its properties cannot be changed.

Examples

The following code example creates a custom event that bubbles but cannot be canceled.

C++


var evt = document.createEvent("Event");
evt.initEvent("custom", true, false);
document.getElementById('target').dispatchEvent(evt);

Deutsch	English	Español	Français
Italiano	日本語	한국어	Português
Pусский	简体中文	繁體中文