Roaming Setting in Windows Store Apps

Introduction

In this article I describe how to create a Windows Store App for Roaming setting using JavaScript. The primary way to store settings for an app is to save them as key-value pairs in either:

Windows.Storage.ApplicationData.current.localSettings or
Windows.Storage.ApplicationData.current.roamingSettings.

Use local Settings for settings that are specific to a device, or useroamingSettings to transition settings between a user's PCs. For roaming, also refer to the High Priority and the Data Changed Event. This app writes, reads, and clears a setting in roaming Settings.

I assume you can create a simple Windows Store App using JavaScript. For more help visit Simple Windows Store Apps using JavaScript.

To start the creation of the app, add two JavaScript pages by right-clicking on the js folder in the Solution Explorer and select Add > new item > JavaScript Page and then give an appropriate name. In the same way, add one HTML page to your project.

Write the following code in default.html:

<!DOCTYPE html>

<html>

<head>

</head>

</div>

</div></center>

</body>

</html>

Write the following code in default.js:

(function () {

"use strict";

var appTitle = "";

var pages = [

{ url: "page.html" }

];

function activated(eventObject) {

if (eventObject.detail.kind === Windows.ApplicationModel.Activation.ActivationKind.launch) {

eventObject.setPromise(WinJS.UI.processAll().then(function () {

var url = WinJS.Application.sessionState.lastUrl || pages[0].url;

return WinJS.Navigation.navigate(url);

}));

}

WinJS.Navigation.addEventListener("navigated", function (eventObject) {

var url = eventObject.detail.location;

var host = document.getElementById("contentHost");

host.winControl && host.winControl.unload && host.winControl.unload();

WinJS.Utilities.empty(host);

eventObject.detail.setPromise(WinJS.UI.Pages.render(url, host, eventObject.detail.state).then(function () {

WinJS.Application.sessionState.lastUrl = url;

}));

});

WinJS.Namespace.define("App", {

appTitle: appTitle,

pages: pages

});

WinJS.Application.addEventListener("activated", activated, false);

WinJS.Application.start();

})();

Write the following code in page.html:

<!DOCTYPE html>

<html>

<head>

</head>

<body>

<button id="settingsWriteSetting">Write setting</button>

<button id="settingsDeleteSetting">Delete setting</button>

</div>

</div>

</body>

</html>

Write the following code in script.js:

(function () {

"use strict";

var page = WinJS.UI.Pages.define("page.html", {

ready: function (element, options) {

document.getElementById("settingsWriteSetting").addEventListener("click", settingsWriteSetting, false);

document.getElementById("settingsDeleteSetting").addEventListener("click", settingsDeleteSetting, false);

settingsDisplayOutput();

}

});

var localSettings = Windows.Storage.ApplicationData.current.localSettings;

var settingName = "exampleSetting";

var settingValue = "Deepak Arora";

function settingsWriteSetting() {

localSettings.values[settingName] = settingValue;

settingsDisplayOutput();

}

function settingsDeleteSetting() {

localSettings.values.remove(settingName);

settingsDisplayOutput();

}

function settingsDisplayOutput() {

var value = localSettings.values[settingName];

if (!value) {

document.getElementById("settingsOutput").innerText = "Setting: <empty>";

} else {

document.getElementById("settingsOutput").innerText = "Setting: \"" + value + "\"";

}

})();

Write the following code in script1.js:

(function () {

var pageOutput = WinJS.Class.define(

function (element, options) {

element.winControl = this;

this.element = element;

new WinJS.Utilities.QueryCollection(element)

.setAttribute("role", "region")

.setAttribute("aria-labelledby", "outputLabel")

.setAttribute("aria-live", "assertive");

element.id = "output";

this._addOutputLabel(element);

this._addStatusOutput(element);

}, {

_addOutputLabel: function (element) {

var label = document.createElement("h2");

label.id = "outputLabel";

label.textContent = "";

element.parentNode.insertBefore(label, element);

_addStatusOutput: function (element) {

var statusDiv = document.createElement("div");

statusDiv.id = "statusMessage";

element.insertBefore(statusDiv, element.childNodes[0]);

}

);

var currentpageUrl = null;

WinJS.Navigation.addEventListener("navigating", function (evt) {

currentpageUrl = evt.detail.location;

});

WinJS.log = function (message, tag, type) {

var statusDiv = document.getElementById("statusMessage");

};

function activated(e) {

WinJS.Utilities.query("#featureLabel")[0].textContent = App.appTitle;

}

WinJS.Application.addEventListener("activated", activated, false);

WinJS.Namespace.define("App", {

pageOutput: pageOutput

});

})();

Output:

Summary

In this app I described roaming setting in a Windows Store App using JavaScript. I hope this article has helped you to understand this topic. Please share if you know more about this. Your feedback and constructive contributions are welcome.