Click here to Skip to main content
15,887,596 members
Articles / Programming Languages / C#
Tip/Trick

Store Generic Classes in Settings

Rate me:
Please Sign up or sign in to vote.
5.00/5 (5 votes)
24 Aug 2012CPOL 15.2K   4   2
How to store generic classes in settings

Introduction

There are some situations where it's very useful to store an array of custom objects in settings. I had one today. I've tried using ArrayList but my custom objects were not saved. I thought it would be great if I could directly save list of custom type in settings. This meant that my only problem was how to make use of generics in settings that was solved quite simply with this method.

Limitation

This can't be used for Dictionary and Tuple.

Using the Code

To use generic classes in settings, you have to create a wrapper class that extends generic class and use it as type of setting property. Here's a simple example:

C#
public class MyClass //Custom class for list
{
    public int MyProperty { get; set; } //just for example
}

public class MyClassList : List<MyClass> { } //Wrapper class of list of type MyClass 
C#
//Simple Console Application for Test
static void Main(string[] args)
{
    MyClassList list = new MyClassList();
    list.Add(new MyClass() { MyProperty = 5 });
    Properties.Settings.Default.MySetting = list; //MySetting is type of MyClassList
    Properties.Settings.Save();
}    

After compiling this test application, you can delete your code and see if settings have saved:

C#
//Simple Console Application for test
static void Main(string[] args)
{
    foreach (MyClass item in Properties.Settings.MySetting)
    {
        Console.WriteLine(item.MyProperty);
    }
    Console.Read();
}    

Conclusion

I hope this will be useful for someone who'll have the same needs as I had and won't spend one hour on thinking about how to do what he wants.

License

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


Written By
Software Developer
Georgia Georgia
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralMy vote of 5 Pin
Christian Amado24-Aug-12 16:42
professionalChristian Amado24-Aug-12 16:42 
GeneralRe: My vote of 5 Pin
Leri Buiglishvili25-Aug-12 2:24
Leri Buiglishvili25-Aug-12 2:24 

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

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