jakeginnivan / settingsprovider.net

Simple Settings provider for .net applications

SettingsProvider.NET

The aim of settings provider is to quickly give you a simple way to store application settings and read metadata about those settings, like description, name, default values etc

v2 Has added a few things to make versioning easier, the Key attribute allows you to rename properties, and types are no longer fully qualified (so you can move classes)

Usage

Start of by creating your settings class, marking up with metadata

public class MySettings
{
    [DefaultValue("Jake")]
    [DisplayName("Your Name")]
    public string Name { get; set; }

    [DefaultValue(true)]
    [Description("Should Some App Remember your name?")]
    public bool RememberMe { get;set; }

    public List<Guid> Favourites { get;set; }

    [Key("OriginalName")]
    public string Renamed { get; set; }

    [ProtectedString]
    public string Encrypted { get; set; }
}

Reading Settings

var settingsProvider = new SettingsProvider(); //By default uses IsolatedStorage for storage
var mySettings = settingsProvider.GetSettings<MySettings>();
Assert.True(mySettings.RememberMe); 

Saving Settings

var settingsProvider = new SettingsProvider(); //By default uses IsolatedStorage for storage
var mySettings = new MySettings { Name = "Mr Ginnivan" };
settingsProvider.Save(mySettings);

Settings MetaData

This is handy if you want to generate a UI for your settings

var settingsProvider = new SettingsProvider();
foreach (var setting in settingsProvider.ReadSettingMetadata<MySettings>())
{
    Console.WriteLine("{0} ({1}) - {2}", setting.DisplayName, setting.Description, setting.DefaultValue);
}
// Prints:
//
// Your Name () - Jake
// RememberMe (Should Some App Remember your name?) - true

Additional Notes

• Nested complex types do not have the same features and simply use the DataContractJsonSerializer to serialise

settingsprovider.net's Issues

Bug: settings file does not update after adding new parameter

see subject

shared settings

Hello there. I simply love this package. I was wondering if there is any way to share the created settings between two projects?

I want to be able to create the settings from a wpf app and then have a windows service read from them. Is this possible?

Thanks

IsolatedStorage fails when user is on Roaming Profiles

Looks like an issue with using roaming profiles and UNC paths. It's been reported here and here.

My question, why not use local profiles by default since the roaming profiles with isolated storage seem to be broken?

Encoding issue

See Code52/DownmarkerWPF#355 for details

Settings not written

Hi Again

I am using the nuget in a class library i call to save settings. However i can see the file being created but it appears to be empty and when I try to read it, i get empty values. What am I doing wrong?

Please help.