IApplicationSettingsProvider インターフェイス

定義

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

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

注釈

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

  • アプリケーションのさまざまなバージョンの並列実行。

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

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

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

注意

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

メソッド

GetPreviousVersion(SettingsContext, SettingsProperty)

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

Reset(SettingsContext)

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

Upgrade(SettingsContext, SettingsPropertyCollection)

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

適用対象

こちらもご覧ください