IApplicationSettingsProvider インターフェイス

定義

クライアント ベースのアプリケーション設定プロバイダーの拡張機能を定義します。

public interface class IApplicationSettingsProvider
public interface IApplicationSettingsProvider
type IApplicationSettingsProvider = interface
Public Interface IApplicationSettingsProvider
派生

注釈

アプリケーション設定アーキテクチャでは、 SettingsProviderから派生したクラスであるカスタム設定プロバイダーを作成することで、アプリケーション設定のカスタム ストレージ メカニズムを提供できます。 このようなクラスには、プロパティを格納および取得するための基本的な機能が含まれています。 ただし、カスタム設定プロバイダーに IApplicationSettingsProvider インターフェイスを実装することで、標準化された機能を追加できます。 このインターフェイスには、主に設定プロバイダーがアプリケーションバージョンの変更をよりインテリジェントに処理できるようにする 3 つのメソッドが含まれています。 通常、設定プロバイダーは、次の状況を予測するために、アプリケーションのさまざまなバージョンのアプリケーション設定を個別に格納します。

  • アプリケーションの異なるバージョンの並列実行。

  • アプリケーションのアップグレード時のアプリケーション設定の保持。

  • アプリケーション設定を現在使用されているバージョンの既定値にリセットする。

LocalFileSettingsProvider クラスは IApplicationSettingsProvider インターフェイスを実装しています。 IApplicationSettingsProviderに含まれるメソッドの同じセットが ApplicationSettingsBase クラスにも見つかり、アプリケーション設定ラッパーとその設定プロバイダーの間に定義済みの通信チャネルを確立できます。

Note

このインターフェイスは省略可能です。 プロバイダーがこのインターフェイスを実装していない場合、設定インフラストラクチャは、このインターフェイスで定義されているメソッドのいずれかにアクセスしようとすると、通知なしで失敗します。

メソッド

名前 説明
GetPreviousVersion(SettingsContext, SettingsProperty)

同じアプリケーションの以前のバージョンの指定した設定プロパティの値を返します。

Reset(SettingsContext)

指定したアプリケーションに関連付けられているアプリケーション設定を既定値にリセットします。

Upgrade(SettingsContext, SettingsPropertyCollection)

アプリケーションがアップグレードされたことをプロバイダーに示します。 これにより、プロバイダーは、保存されている設定を必要に応じてアップグレードできます。

適用対象

こちらもご覧ください