SettingsProvider クラス

定義

名前空間:

System.Configuration

アセンブリ:

System.Configuration.ConfigurationManager.dll

パッケージ:

System.Configuration.ConfigurationManager v8.0.0

ソース:

SettingsProvider.cs

アプリケーション設定アーキテクチャでカスタム設定プロバイダーを派生させるための基本クラスとして機能します。

C#

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

継承

Object

ProviderBase

SettingsProvider

派生

System.Configuration.LocalFileSettingsProvider

System.Web.ClientServices.Providers.ClientSettingsProvider

System.Web.Profile.ProfileProvider

注釈

設定プロバイダーは、アプリケーション設定アーキテクチャで使用される構成データを格納するためのメカニズムを定義します。 .NET Frameworkには、LocalFileSettingsProvider構成データをローカル ファイル システムに格納する 1 つの既定の設定プロバイダー が含まれています。 ただし、抽象 SettingsProvider クラスから派生することで、代替ストレージ メカニズムを作成できます。 ラッパー クラスが使用するプロバイダーは、 でラッパー クラス SettingsProviderAttributeを修飾することによって決定されます。 この属性が指定されていない場合は、 LocalFileSettingsProvider既定の が使用されます。

カスタム設定プロバイダーを作成するときは、少なくとも、このクラス GetPropertyValuesの 3 つのメソッド (、 SetPropertyValues および ApplicationName) の実装を指定する必要があります。

クライアント アプリケーションの場合は、 インターフェイスも実装することで、より標準化された機能をカスタム プロバイダーに IApplicationSettingsProvider 追加できます。 このインターフェイスは、 クラスで見つかったメソッドを ApplicationSettingsBase ミラー化し、主にバージョン管理のサポートを可能にします。

通常は、ストレージ リソースの競合を回避するために、設定プロバイダーを単一インスタンスに設計する必要があります。 プロバイダーは、1 つのアプリケーション ドメイン内の複数のラッパー インスタンスから、または異なるドメイン内の複数のアプリケーションから同時に呼び出すことができるため、スレッド セーフである必要もあります。

少なくとも、設定プロバイダーは、、UserScopedSettingAttribute、および DefaultSettingValueAttributeの 3 つの属性をApplicationScopedSettingAttribute認識する必要があります。 アプリケーション設定に適用できる属性の完全な一覧については、「 アプリケーション設定の属性」を参照してください。 カスタム設定プロバイダーは、設定プロパティに適用される属性を次のように解決する必要があります。

1. プロバイダーが 属性によって暗黙的に指定された要求を満たすことができる場合は、明らかにそうする必要があります。

2. プロバイダーが要求を満たすことができない場合は、サイレントで無視する必要があります。

3. 2 つ以上のプロパティが競合する場合。たとえば、 プロパティが と UserScopedSettingAttributeの両方ApplicationScopedSettingAttributeで修飾されている場合、プロバイダーは をConfigurationExceptionスローする必要があります。

コンストラクター

SettingsProvider()

SettingsProvider クラスのインスタンスを初期化します。

プロパティ

ApplicationName	現在実行中のアプリケーションの名前を取得または設定します。
Description	管理ツールまたは他のユーザー インターフェイス (UI) での表示に適した、簡単でわかりやすい説明を取得します。 (継承元 ProviderBase)
Name	構成時にプロバイダーを参照するために使用される表示名を取得します。 (継承元 ProviderBase)

メソッド

Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetPropertyValues(SettingsContext, SettingsPropertyCollection)	指定したアプリケーションのインスタンスと設定プロパティ グループの、設定プロパティ値のコレクションを返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Initialize(String, NameValueCollection)	構成ビルダーを初期化します。 (継承元 ProviderBase)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
SetPropertyValues(SettingsContext, SettingsPropertyValueCollection)	指定したプロパティ設定グループの値を設定します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

こちらもご覧ください

• IApplicationSettingsProvider
• LocalFileSettingsProvider
• SettingsProviderAttribute
• ApplicationSettingsBase
• ConfigurationException
• アプリケーション設定アーキテクチャ
• アプリケーション設定の属性