NavBarCommand.dispatchEvent method

[NavBarCommand is no longer available for use as of Windows Library for JavaScript (WinJS) 4.2. Instead, use SplitViewCommand. ]

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

Syntax

var boolean = navBarCommand.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 2.0

Namespace

WinJS.UI

See also

NavBarCommand

NavBarCommand

NavBar

NavBarContainer

BackButton

AppBar

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