dispatchEvent method

Sends an event to the current element.

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

Syntax

object.dispatchEvent(evt, pfResult)

Parameters

evt [in]

Type: IDOMEvent

The event object to dispatch.

pfResult [out, retval]

Type: Boolean

A Boolean value that indicates whether any of the event handlers called preventDefault.

true (true): Default. The default action is permitted.
false (false): The caller should prevent the default action.

Return value

Type: Boolean

A Boolean value that indicates whether any of the event handlers called preventDefault.

true

Default. The default action is permitted.

false

The caller should prevent the default action.

Standards information

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

Remarks

Events that the dispatchEvent method dispatches are subject to the same capturing and bubbling behavior as events that the browser dispatches.

You cannot cancel some events. For more information, see the documentation for the event.

In general, events can only be dispatched from elements that are part of the document object model, per the HTML5 specification.

JavaScript


var a = document.createElement('a');
var evt = document.createEvent('MouseEvents');
evt.initEvent("click", true, true);
a.dispatchEvent(evt);

For interoperability purposes, however, Internet Explorer for Windows Phone 8.1 Update allows events to be triggered by elements that are not part of the document object model. For best results, dynamically created elements should be added to the document object model.