DOMEventMixin.dispatchEvent method

  • Article

Raises an event of the specified type, adding the specified additional properties.

Syntax

var boolean = domEventMixin.dispatchEvent(type, eventProperties);

Parameters

  • type
    Type: String

    The type (name) of the event.

  • eventProperties
    Type: Object

    The set of additional properties to be attached to the event object when the event is raised.

Return value

Type: Boolean

true if preventDefault was called on the event, otherwise false.

Requirements

Minimum WinJS version

WinJS 3.0

Namespace

WinJS.UI

See also

DOMEventMixin