dispatchEvent method

Article
05/02/2017

Sends an event to the current element.

Syntax

HRESULT retVal = object.dispatchEvent(evt, pfResult);

Parameters

evt [in]

Type: IDOMEvent

The event object to dispatch.

pfResult [out, retval]

Type: VARIANT_BOOL

A VARIANT_BOOL value that indicates whether any of the event handlers called IDOMEvent::preventDefault.

VARIANT_TRUE (true)

Default. The default action is permitted.

VARIANT_FALSE (false)

The caller should prevent the default action.

Return value

Type: HRESULT

This method can return one of these values.

Return code	Description
S_OK	The operation completed successfully.
NotSupportedError	You cannot dispatch an internal event.

Standards information

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

Remarks

Events that the IEventTarget::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.

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.

Share via