Click here to Skip to main content
11,805,316 members (65,793 online)
Click here to Skip to main content

AppSettings Implementation for Compact Framework

, 23 Mar 2004 CPOL 88.9K 713 59
Rate this:
Please Sign up or sign in to vote.
Learn how to create a settings class that will make it easy to access and store your application settings.

Sample Image - SaveSettings.jpg


The .NET Compact Framework does not contain an AppSettings class like the full framework. On the full .NET Framework a developer could gain access to settings stored in the App.Config file by creating a name value collection from the System.Configuration.ConfigurationSettings.AppSettings class. As an advocate of uniformity, I wanted to create something that had similar functionality on the Compact Framework. This article will show you what I came up with.

Using the code

My first step was to create an XML file that looked a lot like the App.Config file in .NET.

<?xml version="1.0" encoding="utf-8" ?>
        <add key="ServerIP" value="" />
        <add key="UserName" value="testuser" />
        <add key="Password" value="jdhs822@@*" />
        <add key="PhoneNumber" value="5555555555" />
        <add key="TimeOut" value="60" />
        <add key="LastTransmit" value="03/03/2004 9:12:33 PM" />
        <add key="DatabasePath" value="\Program Files\DB\test.sdf" />

I named this file Settings.xml and added it to my project with a build action of content. This ensures that the file will get downloaded to my program's executing folder.

My next step was to create a new class called Settings. This class contains only static members so the settings are accessed from the file only once during program execution and the entire program will have easy access to these values.

I wanted the settings to be loaded as soon as the settings were accessed, so I created a static constructor and placed my XML parsing code inside the constructor.

m_settings is a NameValueCollection that stores all of the settings.

public class Settings
    private static NameValueCollection m_settings;
    private static string m_settingsPath;

    // Static Ctor
    static Settings()
        // Get the path of the settings file.
        m_settingsPath = Path.GetDirectoryName(
        m_settingsPath += @"\Settings.xml";

            throw new FileNotFoundException(
                              m_settingsPath + " could not be found.");

        System.Xml.XmlDocument xdoc = new XmlDocument();
        XmlElement root = xdoc.DocumentElement;
        System.Xml.XmlNodeList nodeList = root.ChildNodes.Item(0).ChildNodes;

        // Add settings to the NameValueCollection.
        m_settings = new NameValueCollection();
        m_settings.Add("ServerIP", nodeList.Item(0).Attributes["value"].Value);
        m_settings.Add("UserName", nodeList.Item(1).Attributes["value"].Value);
        m_settings.Add("Password", nodeList.Item(2).Attributes["value"].Value);
        m_settings.Add("TimeOut", nodeList.Item(4).Attributes["value"].Value);

Now, we need some public accessors to retrieve the values from the NameValueCollection.

public static string ServerIP
    get { return m_settings.Get("ServerIP"); }
    set { m_settings.Set("ServerIP", value); }

public static string UserName
    get { return m_settings.Get("UserName"); }
    set { m_settings.Set("UserName", value); }

// ... And so on

The only thing left to do is to add a method for updating our settings. The XmlTextWriter class provides us with a light-weight mechanisim for writing xml to a FileStream. We iterate through the NameValueCollection and create the settings in xml.

public static void Update()
    XmlTextWriter tw = new XmlTextWriter(m_settingsPath,

    for(int i=0; i<m_settings.Count; ++i)
        tw.WriteStartAttribute("key", string.Empty);

        tw.WriteStartAttribute("value", string.Empty);



Now we can easily access our settings from anywhere in our application!


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

Software Developer (Senior)
United States United States
Check out my blog!

You may also be interested in...

Comments and Discussions

SuggestionUse key instead of id Pin
MarownIOM9-Apr-14 6:10
memberMarownIOM9-Apr-14 6:10 
GeneralMy vote of 3 Pin
b0bi21-Jun-11 21:01
memberb0bi21-Jun-11 21:01 
GeneralDid exactly what it should Pin
Bernhard11-Mar-10 22:46
memberBernhard11-Mar-10 22:46 
GeneralMy vote of 1 Pin
Nedyalko Zhekov19-Jan-10 11:22
memberNedyalko Zhekov19-Jan-10 11:22 
QuestionLittle problem Pin
Member #352815616-Mar-07 6:29
memberMember #352815616-Mar-07 6:29 
GeneralAccess Violation Error Pin
r20j30-Nov-05 0:18
memberr20j30-Nov-05 0:18 
GeneralVery Useful Pin
Paul Baker18-Aug-05 10:54
memberPaul Baker18-Aug-05 10:54 
GeneralXML File is not being copied over Pin
jfaubey2000@yahoo.com21-Jul-05 8:42
memberjfaubey2000@yahoo.com21-Jul-05 8:42 
GeneralRe: XML File is not being copied over Pin
zero_joker20-Nov-06 6:27
memberzero_joker20-Nov-06 6:27 
GeneralRe: XML File is not being copied over Pin
Agha.net20-Sep-07 11:44
memberAgha.net20-Sep-07 11:44 
Generaltiny improvement Pin
flair6-Apr-05 21:33
memberflair6-Apr-05 21:33 
GeneralRe: tiny improvement Pin
flair6-Apr-05 21:34
memberflair6-Apr-05 21:34 
GeneralRe: tiny improvement Pin
flair6-Apr-05 21:36
memberflair6-Apr-05 21:36 
GeneralSystem.NullReferenceException Pin
wannafly12-Apr-04 7:36
memberwannafly12-Apr-04 7:36 
GeneralAny chance you could port it to VB Pin
Geovani5-Apr-04 5:56
memberGeovani5-Apr-04 5:56 
GeneralRe: Any chance you could port it to VB Pin
cyn3rgy14-Sep-10 0:45
membercyn3rgy14-Sep-10 0:45 
GeneralA misprint Pin
Alexey Mochalov21-Mar-04 20:47
sussAlexey Mochalov21-Mar-04 20:47 
GeneralRe: A misprint Pin
pbrooks22-Mar-04 4:07
memberpbrooks22-Mar-04 4:07 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.151002.1 | Last Updated 24 Mar 2004
Article Copyright 2004 by pbrooks
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid