SettingsProvider Class

Definition

public ref class SettingsProvider abstract : System::Configuration::Provider::ProviderBase

public abstract class SettingsProvider : System.Configuration.Provider.ProviderBase

type SettingsProvider = class
    inherit ProviderBase

Public MustInherit Class SettingsProvider
Inherits ProviderBase

Inheritance

Object

ProviderBase

SettingsProvider

Derived

System.Configuration.LocalFileSettingsProvider

System.Web.ClientServices.Providers.ClientSettingsProvider

System.Web.Profile.ProfileProvider

Remarks

A settings provider defines the mechanism for storing configuration data used in the application settings architecture. The .NET Framework contains a single default settings provider, LocalFileSettingsProvider, which stores configuration data to the local file system. However, you can create alternate storage mechanisms by deriving from the abstract SettingsProvider class. The provider that a wrapper class uses is determined by decorating the wrapper class with the SettingsProviderAttribute. If this attribute is not provided, the default, LocalFileSettingsProvider, is used.

When you create a custom settings provider, at minimum, you must provide implementations for the three methods of this class: GetPropertyValues, SetPropertyValues and ApplicationName.

For client applications, you can add more standardized functionality to a custom provider by also implementing the IApplicationSettingsProvider interface. This interface mirrors methods found in the ApplicationSettingsBase class, which mainly enables versioning support.

Typically, you should design settings providers to be single-instanced to avoid storage resource contention. Providers should also be thread-safe because they can be called simultaneously from multiple wrapper instances in a single application domain or from multiple applications in different domains.

At minimum, a settings provider must recognize three attributes - ApplicationScopedSettingAttribute, UserScopedSettingAttribute, and DefaultSettingValueAttribute. For a full listing of attributes that can be applied to application settings, see Application Settings Attributes. A custom setting provider should resolve attributes applied to settings properties in the following manner:

1. If the provider can fulfill the request implied by the attribute, obviously it should do so.

2. If the provider cannot fulfill the request, it should ignore it silently.

3. If two or more properties conflict; for example, a property being decorated with both ApplicationScopedSettingAttribute and UserScopedSettingAttribute; the provider should throw a ConfigurationException.

Constructors

Properties

Methods

Applies to

See also

• IApplicationSettingsProvider
• LocalFileSettingsProvider
• SettingsProviderAttribute
• ApplicationSettingsBase
• ConfigurationException
• Application Settings Architecture
• Application Settings Attributes