Pivot.dispatchEvent method

  • Article

Raises an event of the specified type and with additional properties.

Syntax

var boolRef = pivot.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.

Remarks

Note   For Windows, this member is available starting with the WinJS 3.0 library. The WinJS 3.0 library is available via CDN, package manager, or website download but currently not through the Windows Store as a Windows Store framework package.

 

Requirements

Minimum WinJS version

Phone WinJS 2.1

Namespace

WinJS.UI

See also

Pivot