SettingsFlyout.populateSettings method

Applies to Windows only

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 supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

WinJS.UI

Library

Ui.js

See also

SettingsFlyout

 

 

Show:
© 2014 Microsoft. All rights reserved.