SettingsFlyout.populateSettings method
[settingFlyout is no longer available for use as of Windows Library for JavaScript (WinJS) 4.0 Preview.]
Loads a fragment of the SettingsFlyout. Your app calls this when the user invokes a settings command and the WinJS.Application.onsettings event occurs.
Syntax
settingsFlyout.populateSettings(e);
Parameters
e
Type: CustomEvent**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.
Return value
This method does not return a value.
Remarks
This is an example of setting e.detail.applicationcommands and calling populateSettings:
WinJS.Application.onsettings = function (e) {
e.detail.applicationcommands = {
"gameOptionsDiv": { title: "Game options", href: "/html/4-SettingsFlyout-Game.html" }
};
WinJS.UI.SettingsFlyout.populateSettings(e);
};
Requirements
Minimum WinJS version |
WinJS 1.0 |
Namespace |
WinJS.UI |