SettingsProvider クラス
アセンブリ: System (system.dll 内)
構文
解説
設定プロバイダは、アプリケーション設定アーキテクチャで使用する構成データを格納するための機構を定義します。.NET Framework には、既定の設定プロバイダ (LocalFileSettingsProvider) が 1 つ用意されています。このプロバイダは、ローカル ファイル システムに構成データを格納します。ただし、SettingsProvider 抽象クラスから派生させることで、その代わりとなるストレージ機構も作成できます。ラッパー クラスが使用するプロバイダは、ラッパー クラスを SettingsProviderAttribute で修飾して決定します。この属性が提供されない場合は、既定の LocalFileSettingsProvider が使用されます。
カスタム設定プロバイダを作成するときは、少なくとも、このクラスの 3 つのメソッド (GetPropertyValues、SetPropertyValues、および ApplicationName) の実装を提供する必要があります。
クライアント アプリケーションの場合、IApplicationSettingsProvider インターフェイスも実装して、より標準化された機能をカスタム プロバイダに追加できます。このインターフェイスは、主にバージョン管理のサポートを有効にする ApplicationSettingsBase クラスに存在するメソッドを反映します。
通常は、ストレージ リソースの競合を避けるため、単一インスタンス化されるように設定プロバイダを設計する必要があります。また、プロバイダはスレッド セーフにする必要もあります。これはプロバイダを、1 つのアプリケーション ドメイン内の複数のラッパー インスタンスから、または異なるドメインの複数のアプリケーションから同時に呼び出すことができるためです。
少なくとも、設定プロバイダは 3 つの属性 (ApplicationScopedSettingAttribute、UserScopedSettingAttribute、および DefaultSettingValueAttribute) を認識する必要があります。アプリケーション設定に適用できる属性のリスト全体については、「アプリケーション設定の属性」を参照してください。カスタム設定プロバイダは、設定プロパティに適用する属性を次の方法で解決する必要があります。
System.Configuration.Provider.ProviderBase
System.Configuration.SettingsProvider
System.Configuration.LocalFileSettingsProvider
System.Web.Profile.ProfileProvider
プラットフォーム
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
参照
SettingsProvider コンストラクタ
アセンブリ: System (system.dll 内)
構文
解説
これは、この抽象クラスの既定のプロテクト コンストラクタです。派生したカスタム設定プロバイダは、明示的なコンストラクタを提供する必要はありません。これは、Initialize メソッドが通常、すべての初期化を実行するためです。
クライアント コードは通常、設定プロバイダを直接インスタンス化することはありません。代わりに、次の手順で特定の設定プロパティの設定プロバイダを検出します。
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
参照
SettingsProvider クラス
SettingsProvider メンバ
System.Configuration 名前空間
Initialize
ISettingsProviderService インターフェイス
GetSettingsProvider
SettingsProvider プロパティ
パブリック プロパティ
名前 | 説明 | |
---|---|---|
ApplicationName | 現在実行中のアプリケーションの名前を取得または設定します。 | |
Description | 管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。 ( ProviderBase から継承されます。) | |
Name | 構成時にプロバイダを参照するために使用される表示名を取得します。 ( ProviderBase から継承されます。) |
SettingsProvider メソッド
パブリック メソッド
名前 | 説明 | |
---|---|---|
Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。) | |
GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。) | |
GetPropertyValues | 指定したアプリケーションのインスタンスと設定プロパティ グループの、設定プロパティ値のコレクションを返します。 | |
GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) | |
Initialize | プロバイダを初期化します。 ( ProviderBase から継承されます。) | |
ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) | |
SetPropertyValues | 指定したプロパティ設定のグループの値を設定します。 | |
ToString | 現在の Object を表す String を返します。 ( Object から継承されます。) |
名前 | 説明 | |
---|---|---|
Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) | |
MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |
SettingsProvider メンバ
アプリケーション設定アーキテクチャでカスタム設定プロバイダを派生させるための基本クラスとして機能します。
SettingsProvider データ型で公開されるメンバを以下の表に示します。
プロテクト コンストラクタ
パブリック プロパティ
名前 | 説明 | |
---|---|---|
ApplicationName | 現在実行中のアプリケーションの名前を取得または設定します。 | |
Description | 管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。(ProviderBase から継承されます。) | |
Name | 構成時にプロバイダを参照するために使用される表示名を取得します。(ProviderBase から継承されます。) |
名前 | 説明 | |
---|---|---|
Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。) | |
GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。) | |
GetPropertyValues | 指定したアプリケーションのインスタンスと設定プロパティ グループの、設定プロパティ値のコレクションを返します。 | |
GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) | |
Initialize | プロバイダを初期化します。 (ProviderBase から継承されます。) | |
ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) | |
SetPropertyValues | 指定したプロパティ設定のグループの値を設定します。 | |
ToString | 現在の Object を表す String を返します。 (Object から継承されます。) |
名前 | 説明 | |
---|---|---|
Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) | |
MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |
- SettingsProviderのページへのリンク