IApplicationSettingsProvider Interface

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v9.0.0-rc.2.24473.5

Source:

IApplicationSettingsProvider.cs

Defines extended capabilities for client-based application settings providers.

public interface class IApplicationSettingsProvider

public interface IApplicationSettingsProvider

type IApplicationSettingsProvider = interface

Public Interface IApplicationSettingsProvider

Derived

System.Configuration.LocalFileSettingsProvider

System.Web.ClientServices.Providers.ClientSettingsProvider

Remarks

The application settings architecture enables you to provide a custom storage mechanism for application settings by creating a custom settings provider, which is a class derived from SettingsProvider. Such a class contains the basic functionality for storing and retrieving properties. However, you can add additional standardized functionality by implementing the IApplicationSettingsProvider interface in the custom settings provider. This interface contains three methods that primarily enable the settings provider to more intelligently handle application version changes. Typically, the settings provider will store application settings for different versions of an application separately to anticipate the following circumstances:

• Side-by-side execution of different versions of an application.

• Retaining application settings when upgrading an application.

• Resetting the application settings to their default values for the currently used version.

The LocalFileSettingsProvider class implements the IApplicationSettingsProvider interface. The same set of methods contained by IApplicationSettingsProvider is also found in the ApplicationSettingsBase class, enabling the establishment of a predefined communication channel between an application settings wrapper and its settings provider.

Note

This interface is optional. If a provider does not implement this interface, the settings infrastructure will fail without notification if it attempts to access any of the methods defined by this interface.

Methods

GetPreviousVersion(SettingsContext, SettingsProperty)	Returns the value of the specified settings property for the previous version of the same application.
Reset(SettingsContext)	Resets the application settings associated with the specified application to their default values.
Upgrade(SettingsContext, SettingsPropertyCollection)	Indicates to the provider that the application has been upgraded. This offers the provider an opportunity to upgrade its stored settings as appropriate.

See also

• SettingsProvider
• ApplicationSettingsBase
• Application Settings Architecture