NavBarCommand.state property

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

Gets or sets a user-defined object that represents the state associated with the command's location.

Syntax

<div 
    data-win-control="WinJS.UI.NavBarCommand" 
    data-win-options="{ state : value}">
</div>
var state = navBarCommand.state;
navBarCommand.state = state;

Property value

Type: Object

The state associated with the current location. This object may contain any values associated with the current location, for example the title of the page. When the navigation command is invoked, it passes this object to the WinJS.Navigation.navigate function.

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