AppBar.dispatchEvent method

Raises an event of the specified type and with additional properties. Learn about custom events with Adding functionality with WinJS mixins.

Syntax

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

Parameters

• type
  Type: string

  The type (name) of the event. It must be beforeopen, beforeclose, afteropen, or afterclose

• 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 1.0
Namespace	WinJS.UI

See also

AppBar

AppBarCommand

AppBarIcon

BackButton

NavBar

Your first app - Part 3: PageControl objects and navigation

Navigating between pages (HTML)

Adding app bars

Adding nav bars

HTML AppBar control sample

HTML NavBar control sample

Navigation and navigation history sample

Designers

Command patterns

Navigation patterns

Guidelines for app bars

Bottom app bar

Top app bar