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

Simple settings using Generics and XML serialization

, 23 Aug 2007 CPOL
Rate this:
Please Sign up or sign in to vote.
An easy and very dynamic way of saving your settings.

Introduction

Very often, when coding an application, you need to store your settings that you can easily load when the program starts. I guess most people use the app.config or settings, but I don't think using those is the best solution. Therefore, I came up with this very easy to use class that enables you to store any type of class to an XML file that can be reloaded very easily.

Using the code

The XmlSettings class uses XML serialization, a very basic and extremely fast method. The Load method takes XMLPath as an argument, and returns our type.

The Save method also takes the XMLpath argument and the T settings argument. T settings is the type you want to be serialized.

public static T Load(string XMLPath)
{
     //Load settings and return our type

     T temp;
     XmlSerializer DeSerializer = new XmlSerializer(typeof(T));
     TextReader reader = new StreamReader(XMLPath);
     temp = (T)DeSerializer.Deserialize(reader);
     reader.Close();
     return temp;
}

public static void Save(string XMLPath, T settings)
{
     //Save settings to xml using our type
     
     XmlSerializer serializer = new XmlSerializer(typeof(T));
     TextWriter writer = new StreamWriter(XMLPath);
     serializer.Serialize(writer, settings);
     writer.Close();
}

Using the XMLSettings class is very basic.

When you want to save settings, first create your settings class with the variables you need in your program. Make sure it has a parameterless constructer. Give it the path to your XML file, and make sure all folders are created. Then, pass your settings class as well.

//Save
XMLSettings<MySettings>.Save(XMLPath, Settings);

When loading, the Load method simply returns your type. Just pass the XML path to the method, and voila!

//Load
setting = XMLSettings<MySettings>.Load(XMLPath);

License

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

Share

About the Author

Lasse Offt

Denmark Denmark
No Biography provided

Comments and Discussions

 
QuestionString Name Required? PinmemberDean K11-Sep-07 23:03 
AnswerRe: String Name Required? PinmemberWb-FreeKill11-Sep-07 23:49 
AnswerRe: String Name Required? PinmemberDean K11-Sep-07 23:58 
GeneralRe: String Name Required? PinmemberWb-FreeKill12-Sep-07 0:18 
GeneralRe: String Name Required? PinmemberDean K12-Sep-07 16:17 
GeneralRe: String Name Required? PinmemberWb-FreeKill12-Sep-07 22:12 
GeneralRe: String Name Required? PinmemberDean K13-Sep-07 1:01 
GeneralRe: String Name Required? PinmemberWb-FreeKill13-Sep-07 1:03 

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
Web01 | 2.8.150331.1 | Last Updated 23 Aug 2007
Article Copyright 2007 by Lasse Offt
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid