Click here to Skip to main content
Click here to Skip to main content

Read/Write Configuration in XML file

, 9 Sep 2005
Rate this:
Please Sign up or sign in to vote.
An article on how to read/write App configuration data in an easy way.

Sample Image

Introduction

A class with a simple, easy to use interface, is ready to help every one to read/write application configuration in an effective way.

Background

First of all, I don't like ConfigurationSettings provided by the .NET framework, as I can not change the config as I want in the App. I did see many articles on the topic, but either they are too big and complex, get me distracted, or can not meet my requirement. My goal is simple: provide a default setting when first launching the App, and on exit, "remember" the user's preference. Registry is another option, but I prefer XML files, which you can open and check more conveniently.

Using the code

All the settings is set by key/value pairs in an XML file, you can insert/update/delete any key/value. The three major public methods are: GetValue, SetValue, removeElement, it's that simple. By default, the XML file should be put in the same folder as your EXE file.

GetValue, key= "CountryLoc"
Config config = new Config();
config.cfgFile = "app.config"; 

txtCountry.Text = 
  config.GetValue("//appSettings//add[@key='CountryLoc']");

I exposed //appSettings in the interface, as you may need access to key/value in different sections. For instance, if you GetValue from key1 in Company section, you can use:

config.GetValue("//Company//add[@key='key1']");

If the section is new, you need to set it up, for example, manually add <Company> </Company> into <configuration>...</configuration>. As in my case, I only have one section, so if you do not like manual thing, you are very welcome to put your code to enhance it. SetValue is quite similar:

config.SetValue("//appSettings//add[@key='" 
                   + txtKey.Text + "']", txtValue.Text);
// config.SetValue("//Company//add[@key='" + 
                     txtKey.Text + "']", txtValue.Text);

Remove element:

//config.removeElement("//Company//add[@key='" + 
//                         txtKey2.Text + "']");
config.removeElement("//appSettings//add[@key='" + 
                             txtKey2.Text + "']");

Reference

This article is based on some code I found on the internet which I have forgotten where it is.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Michael Chao

Canada Canada
No Biography provided

Comments and Discussions

 
GeneralMy vote of 5 PinmemberMember 78911884-May-11 1:40 
GeneralStill very usefull PinmemberPiet Pelle7-Jun-09 4:55 
Thanks saved me a lot of time !
GeneralGetting all Keys/Values for a config section PinmemberHeinz Ruebe31-Jul-08 5:22 
Generalmy questions (mabey nothing to do about this article) Pinmembercooleader29-Jul-07 23:19 
GeneralEasier Use Pinmemberfeiry24-Jan-07 15:36 
GeneralJust what I was looking for. PinmemberDavepow162-Dec-05 19:30 
Questionhow about serialization? PinmemberChris_O11-Sep-05 5:52 
AnswerThanks for your feedback, it's so interesting Pinmembermichael zhao11-Sep-05 6:47 

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 | Mobile
Web02 | 2.8.140721.1 | Last Updated 9 Sep 2005
Article Copyright 2005 by Michael Chao
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid