×
Namespaces

Variants
Actions
(Difference between revisions)

Saving application preferences in Windows Phone

From Nokia Developer Wiki
Jump to: navigation, search
hamishwillee (Talk | contribs)
m (Hamishwillee - Add SeeAlso)
hamishwillee (Talk | contribs)
m (Hamishwillee - Add WP8.0 clarification)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Windows Phone]][[Category:Silverlight]][[Category:Code Snippet]][[Category:Files/Data]][[Category:Application Framework]][[Category:Windows Phone 7.5]]
+
[[Category:Files/Data on Windows Phone]][[Category:Application Framework on Windows Phone]][[Category:Code Snippet]][[Category:XAML]][[Category:Windows Phone 7.5]][[Category:Windows Phone 8]]
{{Abstract|This article explains how to save and load application preferences using [http://msdn.microsoft.com/en-us/library/system.io.isolatedstorage.isolatedstoragesettings(v=vs.95).aspx IsolatedStorageSettings] on Windows Phone 7.5. }}  
+
{{Abstract|This article explains how to save and load application preferences using [http://msdn.microsoft.com/en-us/library/system.io.isolatedstorage.isolatedstoragesettings(v=vs.95).aspx IsolatedStorageSettings] on Windows Phone 7.5 and 8.0. }}  
 
{{SeeAlso|
 
{{SeeAlso|
 +
* [http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj714090(v=vs.105).aspx Quickstart: Working with settings in Windows Phone]
 
*[http://msdn.microsoft.com/en-us/library/cc221360(v=vs.95).aspx How to: Store and Retrieve Application Settings Using Isolated Storage] (MSDN)
 
*[http://msdn.microsoft.com/en-us/library/cc221360(v=vs.95).aspx How to: Store and Retrieve Application Settings Using Isolated Storage] (MSDN)
 
* [[Introduction and best practices for IsolatedStorageSettings]]
 
* [[Introduction and best practices for IsolatedStorageSettings]]
Line 9: Line 10:
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
|devices= Nokia Lumia 800
+
|devices= Nokia Lumia 800, Nokia Lumia 920
 
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Qt SDK 1.1.4]) -->
 
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Qt SDK 1.1.4]) -->
|platform= Windows Phone 7.5
 
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
 
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
Line 146: Line 146:
  
 
== Further reading ==
 
== Further reading ==
 +
#  [http://msdn.microsoft.com/en-us/library/windowsphone/develop/jj714090(v=vs.105).aspx Quickstart: Working with settings in Windows Phone]
 
# [http://msdn.microsoft.com/en-us/library/cc221360(v=vs.95).aspx How to: Store and Retrieve Application Settings Using Isolated Storage]
 
# [http://msdn.microsoft.com/en-us/library/cc221360(v=vs.95).aspx How to: Store and Retrieve Application Settings Using Isolated Storage]
 
# [http://msdn.microsoft.com/en-us/library/system.io.isolatedstorage.isolatedstoragesettings(v=vs.95).aspx IsolatedStorageSettings class]
 
# [http://msdn.microsoft.com/en-us/library/system.io.isolatedstorage.isolatedstoragesettings(v=vs.95).aspx IsolatedStorageSettings class]

Latest revision as of 08:14, 10 September 2013

This article explains how to save and load application preferences using IsolatedStorageSettings on Windows Phone 7.5 and 8.0.

WP Metro Icon File.png
SignpostIcon XAML 40.png
WP Metro Icon WP8.png
SignpostIcon WP7 70px.png
Article Metadata
Tested with
Devices(s): Nokia Lumia 800, Nokia Lumia 920
CompatibilityArticle
Keywords: IsolatedStorageSettings
Created: manikantan (30 Jan 2012)
Last edited: hamishwillee (10 Sep 2013)

Contents

[edit] Introduction

Saving user preferences is a common task requirement for applications. Common scenarios include saving the user's country, top scores in games, game sounds, login ids etc.

This articles discusses the procedure to save and load such user preferences using IsolatedStorageSettings class. It provides a dictionary-like, key-value store which is preserved across device reboots. The settings are securely stored inside the Isolated Storage space of an application, and are inaccessible to other applications.

In order to work best with the application life-cycle we load and save the settings when the settings page is loaded.

[edit] Sample application

Below, we create a simple application that stores the user's preferences in a game. Three elements such as Game Music, Timed Mode and Difficulty level have been identified as preferences for a game. Since Game Music and Timed Mode essentially hold boolean values, in the UI of application we use ToggleSwitch. ToggleSwitch does not come along with the Windows Phone SDK and has to be downloaded separately from codeplex and installed. This has been described here. This is rich resource for Windows Phone controls. Lets create the user interface for the settings page in XAML.

<phone:PhoneApplicationPage 
x:Class="Pref.MainPage"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:phone="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone"
xmlns:shell="clr-namespace:Microsoft.Phone.Shell;assembly=Microsoft.Phone"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:toolbox="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone.Controls.Toolkit"
mc:Ignorable="d" d:DesignWidth="480" d:DesignHeight="768"
FontFamily="{StaticResource PhoneFontFamilyNormal}"
FontSize="{StaticResource PhoneFontSizeNormal}"
Foreground="{StaticResource PhoneForegroundBrush}"
SupportedOrientations="Portrait" Orientation="Portrait"
shell:SystemTray.IsVisible="True">
 
<!--LayoutRoot is the root grid where all page content is placed-->
<Grid x:Name="LayoutRoot" Background="Transparent">
<Grid.RowDefinitions>
<RowDefinition Height="Auto"/>
<RowDefinition Height="*"/>
</Grid.RowDefinitions>
 
<!--TitlePanel contains the name of the application and page title-->
<StackPanel x:Name="TitlePanel" Grid.Row="0" Margin="12,17,0,28">
<TextBlock x:Name="ApplicationTitle" Text="MY GAME" Style="{StaticResource PhoneTextNormalStyle}"/>
<TextBlock x:Name="PageTitle" Text="Settings" Margin="9,-7,0,0" Style="{StaticResource PhoneTextTitle1Style}"/>
</StackPanel>
 
<!--ContentPanel - place additional content here-->
<Grid x:Name="ContentPanel" Grid.Row="1" Margin="12,0,12,0">
 
<toolbox:ToggleSwitch Name="gameMusic" Header="Game Music"></toolbox:ToggleSwitch>
<toolbox:ToggleSwitch Name="timed" Header="Timed Mode" Margin="6,119,6,371"></toolbox:ToggleSwitch>
 
<Slider Height="84" HorizontalAlignment="Left" Margin="12,310,0,0" Name="slider1" VerticalAlignment="Top" Width="418" Value="1" Minimum="1" />
<TextBlock Height="30" HorizontalAlignment="Left" Margin="12,274,0,0" Name="Difficulty" Text="Difficulty Level" VerticalAlignment="Top" Width="135" />
</Grid>
</Grid>
</phone:PhoneApplicationPage>


Above code gives us an UI interface like this.

Application UI

[edit] Code Behind

Instead of having a save and load button on the UI, it is more intuitive to simply load and save preferences when the user navigates TO and FROM the page. Hence in the MainPage.xaml.cs Class, we override the OnNavigatedTo() and OnNavigatedFrom() methods.

namespace Pref
{
public partial class MainPage : PhoneApplicationPage
{
private IsolatedStorageSettings settings;
// Constructor
public MainPage()
{
InitializeComponent();
settings = IsolatedStorageSettings.ApplicationSettings;
}
 
protected override void OnNavigatedTo(NavigationEventArgs e)
{
System.Diagnostics.Debug.WriteLine("into the app");
try
{
System.Diagnostics.Debug.WriteLine("Retrieving values");
gameMusic.IsChecked = (bool)settings["gamemusic"];
timed.IsChecked = (bool)settings["timed"];
slider1.Value = ( Int16)settings["diff"];
 
}
catch(KeyNotFoundException ex)
{
System.Diagnostics.Debug.WriteLine("First Time using the app");
settings.Add("timed", false);
settings.Add("gamemusic", false);
settings.Add("diff", 1);
settings.Save();
 
}
 
}
protected override void OnNavigatedFrom(NavigationEventArgs e)
{
System.Diagnostics.Debug.WriteLine("Exiting, so save now");
settings["timed"] = timed.IsChecked;
settings["diff"] = (Int16) slider1.Value;
settings["gamemusic"] = gameMusic.IsChecked;
settings.Save();
}
}
}

So as you can observe, I am accessing the values in the IsolatedStorageSettings in the form of Key Value pairs. Remember to cast the values when retrieving or saving to this file. It is also reminded that Save() method needs to be called to store or flush these values. If a key is non-existent in the IsolatedStorageSettings, then it may raise KeyNotFoundException.

[edit] Summary

This article describes one of the fundamental tasks in application development - saving and loading user preferences. This is can be extended to many minimal storage use-cases such as top scores in games.

[edit] Further reading

  1. Quickstart: Working with settings in Windows Phone
  2. How to: Store and Retrieve Application Settings Using Isolated Storage
  3. IsolatedStorageSettings class
This page was last modified on 10 September 2013, at 08:14.
444 page views in the last 30 days.
×