Class OptionsSettingsProvider

Namespace

Loehnert.Lisrt.Framework.Services

Assembly

Loehnert.Lisrt.dll

Represents a settings provider that saves settings in the 'Options.settings' file in the Configuration folder.

public class OptionsSettingsProvider : SettingsProviderBase, IApplicationSettingsProvider

Inheritance

object

ProviderBase

SettingsProvider

SettingsProviderBase

OptionsSettingsProvider

Implements

IApplicationSettingsProvider

Inherited Members

SettingsProviderBase.Initialize(string, NameValueCollection)

SettingsProviderBase.GetPropertyValues(SettingsContext, SettingsPropertyCollection)

SettingsProviderBase.Reset(SettingsContext)

SettingsProviderBase.GetPreviousVersion(SettingsContext, SettingsProperty)

SettingsProviderBase.Upgrade(SettingsContext, SettingsPropertyCollection)

SettingsProviderBase.GetGlobalSettingsNode()

SettingsProviderBase.GetLocalSettingsNode()

SettingsProviderBase.ApplicationName

ProviderBase.Description

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

To use the OptionsSettingsProvider with the settings designer, set the Provider property of the setting to Loehnert.Lisrt.Framework.Services.OptionsSettingsProvider.
When you don't use the settings designer, decorate the settings property with the SettingsProviderAttribute ([SettingsProvider(typeof(OptionsSettingsProvider))]).

Constructors

OptionsSettingsProvider()

Initializes a new instance of the OptionsSettingsProvider class.

public OptionsSettingsProvider()

Properties

FilePath

Gets the name for the path.

protected override string FilePath { get; }

Property Value

string

Name

Gets the name of the provider.

public override string Name { get; }

Property Value

string

Methods

SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Sets the values of the specified group of property settings.

public override void SetPropertyValues(SettingsContext context, SettingsPropertyValueCollection collection)

Parameters

context SettingsContext

A SettingsContext describing the current application usage.

collection SettingsPropertyValueCollection

A SettingsPropertyValueCollection representing the group of property settings to set.