LocalFileSettingsProvider クラス


アプリケーション設定クラスに永続性を持たせます。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


プロバイダーの設定は、アプリケーション設定アーキテクチャで使用される構成データを格納するためのメカニズムを定義します。Setting providers define a mechanism for storing configuration data used in the application settings architecture. .NET Framework.NET Framework には、構成データをローカルファイルシステムに格納する既定の設定プロバイダー、LocalFileSettingsProviderが1つ含まれています。The .NET Framework.NET Framework contains a single default settings provider, LocalFileSettingsProvider, which stores configuration data to the local file system. アプリケーション設定のプロパティまたはプロパティのグループは、SettingsProviderAttributeを使用することによって、特定の設定プロバイダーに関連付けられます。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. たとえば、ApplicationSettingsBase のメンバーの多くは、関連付けられている設定プロバイダーに作業を委任します。For example, many of the members of ApplicationSettingsBase delegate their work to the associated settings provider.

LocalFileSettingsProvider 拡張子 .configを持つ構成ファイルに設定を保持します。LocalFileSettingsProvider persists settings to configuration files that have the extension .config. 構成ファイルの内容は、XML ドキュメントとして構成されます。The contents of configuration files are structured as XML documents. 設定のスコープがアプリケーションレベルとユーザーレベルのどちらであるかに応じて、構成データは <applicationSettings> 内の要素として、または <userSettings> セクショングループにそれぞれ格納されます。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. これらのセクショングループはそれぞれ、対応する AppSettingsSection または ClientSettingsSectionによって表されます。Each of these section groups is represented by a corresponding AppSettingsSection or ClientSettingsSection, respectively. 各 section オブジェクトは、IConfigurationSectionHandler型のオブジェクトである構成セクションハンドラーによって所有および管理されます。Each section object is owned and administered by a configuration section handler, which is an object of type IConfigurationSectionHandler.

アプリケーションスコープ設定と既定のユーザースコープ設定は、application.exe.configという名前のファイルに格納されます。このファイルは、実行可能ファイルと同じディレクトリに作成されます。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. 特定のユーザーデータは、ユーザーのホームディレクトリに格納されている user.configという名前のファイルに格納されます。Specific user data is stored in a file named user.config, stored under the user's home directory. 移動プロファイルが有効になっている場合、ユーザー構成ファイルの2つのバージョンが存在する可能性があります。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.

アプリケーション設定の詳細については、「 Windows フォームのアプリケーション設定」を参照してください。For more information about application settings, see Application Settings for Windows Forms.



LocalFileSettingsProvider クラスの新しいインスタンスを初期化します。Initializes a new instance of the LocalFileSettingsProvider class.



現在実行中のアプリケーションの名前を取得または設定します。Gets or sets the name of the currently running application.


管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(継承元 ProviderBase)

構成時にプロバイダーを参照するために使用される表示名を取得します。Gets the friendly name used to refer to the provider during configuration.

(継承元 ProviderBase)



指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetPreviousVersion(SettingsContext, SettingsProperty)

同じアプリケーションの以前のバージョンの、名前付き設定プロパティの値を返します。Returns the value of the named settings property for the previous version of the same application.

GetPropertyValues(SettingsContext, SettingsPropertyCollection)

指定したアプリケーションのインスタンスと設定プロパティ グループの、設定プロパティ値のコレクションを返します。Returns the collection of setting property values for the specified application instance and settings property group.


現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
Initialize(String, NameValueCollection)

プロバイダーを初期化します。Initializes the provider.


現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)

指定したアプリケーションに関連付けられているすべてのアプリケーション設定プロパティを既定値にリセットします。Resets all application settings properties associated with the specified application to their default values.

SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)

指定したプロパティ設定グループの値を設定します。Sets the values of the specified group of property settings.


現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
Upgrade(SettingsContext, SettingsPropertyCollection)

同じアプリケーションの以前のバージョンから、ユーザー スコープの以前の設定の移行を試みます。Attempts to migrate previous user-scoped settings from a previous version of the same application.