Provides users with fast, in-context access to settings that affect the current Windows Store app.
Creates a new SettingsFlyout object.
The DOM element that will host the control.
The set of properties and values to apply to the new SettingsFlyout.
Gets the DOM element the SettingsFlyout is attached to.
Gets whether the SettingsFlyout is hidden.
Gets or sets the settings command Id for the SettingsFlyout control.
This property may be unavailable or altered in future versions. Use the CSS width property of the element that has the win-settingsflyout class instead.
Registers an event handler for the specified event.
The event type to register. It must be beforeshow, beforehide, aftershow, or afterhide.
The event handler function to associate with the event.
Set to true to register the event handler for the capturing phase; otherwise, set to false to register the event handler for the bubbling phase.
Raises an event of the specified type and with additional properties.
The type (name) of the event.
The set of additional properties to be attached to the event object when the event is raised.
boolean
true if preventDefault was called on the event, otherwise false.
Releases resources held by this SettingsFlyout. Call this method when the SettingsFlyout is no longer needed. After calling this method, the SettingsFlyout becomes unusable.
Hides the SettingsFlyout, if visible, regardless of other states.
Raised immediately after the SettingsFlyout is completely hidden.
An object that contains information about the event.
Raised immediately after a SettingsFlyout is fully shown.
An object that contains information about the event.
Raised just before hiding a SettingsFlyout.
An object that contains information about the event.
Raised just before showing a SettingsFlyout.
An object that contains information about the event.
Loads a fragment of the SettingsFlyout. Your app calls this when the user invokes a settings command and the WinJS.Application.onsettings event occurs.
An object that contains information about the event, received from the WinJS.Application.onsettings event. The detail property of this object contains the applicationcommands sub-property that you set to an array of settings commands. You then populate the SettingsFlyout with these commands by a call to populateSettings.
Removes an event handler that the addEventListener method registered.
The event type to unregister. It must be beforeshow, beforehide, aftershow, or afterhide.
The event handler function to remove.
Set to true to remove the capturing phase event handler; set to false to remove the bubbling phase event handler.
Shows the SettingsPane UI, if hidden, regardless of other state.
Shows the SettingsPane UI, if hidden.
Show the Settings flyout using the Settings element identifier (ID) and the path of the page that contains the Settings element.
The ID of the Settings element.
The path of the page that contains the Settings element.