LocalFileSettingsProvider LocalFileSettingsProvider LocalFileSettingsProvider LocalFileSettingsProvider Class

Definition

Provides persistence for application settings classes.

public ref class LocalFileSettingsProvider : System::Configuration::SettingsProvider, System::Configuration::IApplicationSettingsProvider
public class LocalFileSettingsProvider : System.Configuration.SettingsProvider, System.Configuration.IApplicationSettingsProvider
type LocalFileSettingsProvider = class
    inherit SettingsProvider
    interface IApplicationSettingsProvider
Public Class LocalFileSettingsProvider
Inherits SettingsProvider
Implements IApplicationSettingsProvider
Inheritance
LocalFileSettingsProviderLocalFileSettingsProviderLocalFileSettingsProviderLocalFileSettingsProvider
Implements

Remarks

Setting providers define a 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. An application settings property or group of properties are associated to a specific settings provider through the use of the SettingsProviderAttribute.

Typically, the client program does not explicitly access this class; rather, the application settings architecture automatically invokes the appropriate settings provider when its services are required. For example, many of the members of ApplicationSettingsBase delegate their work to the associated settings provider.

LocalFileSettingsProvider persists settings to configuration files that have the extension .config. The contents of configuration files are structured as XML documents. Depending on whether the setting is scoped at either the application-level or user-level, the configuration data is stored as elements within an <applicationSettings> or a <userSettings> section group, respectively. Each of these section groups is represented by a corresponding AppSettingsSection or ClientSettingsSection, respectively. Each section object is owned and administered by a configuration section handler, which is an object of type IConfigurationSectionHandler.

Application-scoped settings and the default user-scoped settings are stored in a file named application.exe.config, which is created in the same directory as the executable file. Application configuration settings are read-only. Specific user data is stored in a file named user.config, stored under the user's home directory. If roaming profiles are enabled, two versions of the user configuration file could exist. In such a case, the entries in the roaming version take precedence over duplicated entries in the local user configuration file.

For more information about application settings, see Application Settings for Windows Forms.

Constructors

LocalFileSettingsProvider() LocalFileSettingsProvider() LocalFileSettingsProvider() LocalFileSettingsProvider()

Initializes a new instance of the LocalFileSettingsProvider class.

Properties

ApplicationName ApplicationName ApplicationName ApplicationName

Gets or sets the name of the currently running application.

Description Description Description Description

Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetPreviousVersion(SettingsContext, SettingsProperty) GetPreviousVersion(SettingsContext, SettingsProperty) GetPreviousVersion(SettingsContext, SettingsProperty) GetPreviousVersion(SettingsContext, SettingsProperty)

Returns the value of the named settings property for the previous version of the same application.

GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection) GetPropertyValues(SettingsContext, SettingsPropertyCollection)

Returns the collection of setting property values for the specified application instance and settings property group.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection)

Initializes the provider.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Reset(SettingsContext) Reset(SettingsContext) Reset(SettingsContext) Reset(SettingsContext)

Resets all application settings properties associated with the specified application to their default values.

SetPropertyValues(SettingsContext, SettingsPropertyValueCollection) SetPropertyValues(SettingsContext, SettingsPropertyValueCollection) SetPropertyValues(SettingsContext, SettingsPropertyValueCollection) SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

Sets the values of the specified group of property settings.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Upgrade(SettingsContext, SettingsPropertyCollection) Upgrade(SettingsContext, SettingsPropertyCollection) Upgrade(SettingsContext, SettingsPropertyCollection) Upgrade(SettingsContext, SettingsPropertyCollection)

Attempts to migrate previous user-scoped settings from a previous version of the same application.

Applies to

See also