SettingsProviderとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

SettingsProvider クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public MustInherit Class
 SettingsProvider
    Inherits ProviderBase

Visual Basic (使用法)

Dim instance As SettingsProvider

public abstract class SettingsProvider : ProviderBase

C++

public ref class SettingsProvider abstract
 : public ProviderBase

public abstract class SettingsProvider extends
 ProviderBase

JScript

public abstract class SettingsProvider extends
 ProviderBase

解説

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

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

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

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

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

プロバイダは属性が示す要求を満たすことができる場合、その要求を実行します。
プロバイダが要求を実行できない場合は、その要求を無視します。
たとえば、プロパティが ApplicationScopedSettingAttribute と UserScopedSettingAttribute の両方で装飾されている場合など、複数のプロパティが競合するときは、プロバイダは ConfigurationException をスローする必要があります。

継承階層

System.Object
   System.Configuration.Provider.ProviderBase
    System.Configuration.SettingsProvider
       System.Configuration.LocalFileSettingsProvider
       System.Web.Profile.ProfileProvider

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SettingsProvider メンバ
System.Configuration 名前空間
IApplicationSettingsProvider インターフェイス
LocalFileSettingsProvider クラス
SettingsProviderAttribute
ApplicationSettingsBase クラス
ConfigurationException クラス
その他の技術情報
アプリケーション設定アーキテクチャ
アプリケーション設定の属性

SettingsProvider コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Protected Sub New

Visual Basic (使用法)

Dim instance As New SettingsProvider

protected SettingsProvider ()

C++

protected:
SettingsProvider ()

protected SettingsProvider ()

JScript

protected function SettingsProvider ()

解説

これは、この抽象クラスの既定のプロテクトコンストラクタです。派生したカスタム設定プロバイダは、明示的なコンストラクタを提供する必要はありません。これは、Initialize メソッドが通常、すべての初期化を実行するためです。

クライアントコードは通常、設定プロバイダを直接インスタンス化することはありません。代わりに、次の手順で特定の設定プロパティの設定プロバイダを検出します。

現在の Component または ISite で GetService メソッドを呼び出して、現在の ISettingsProviderService への参照を返します。
最初の手順で取得した ISettingsProviderService の GetSettingsProvider メソッドを呼び出して、設定プロバイダを返します。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
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 データ型で公開されるメンバを以下の表に示します。

プロテクトコンストラクタ

	名前	説明
	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 から継承されます。)