IApplicationSettingsProvider IApplicationSettingsProvider IApplicationSettingsProvider IApplicationSettingsProvider Interface

定義

クライアント ベースのアプリケーション設定プロバイダーの拡張機能を定義します。Defines extended capabilities for client-based application settings providers.

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

注釈

アプリケーション設定アーキテクチャでは、からSettingsProvider派生したクラスであるカスタム設定プロバイダーを作成することによって、アプリケーション設定のカスタムストレージ機構を提供できます。The application settings architecture enables you to provide a custom storage mechanism for application settings by creating a custom settings provider, which is a class derived from SettingsProvider. このようなクラスには、プロパティを格納および取得するための基本機能が含まれています。Such a class contains the basic functionality for storing and retrieving properties. ただし、カスタム設定プロバイダーにIApplicationSettingsProviderインターフェイスを実装することで、追加の標準化された機能を追加することができます。However, you can add additional standardized functionality by implementing the IApplicationSettingsProvider interface in the custom settings provider. このインターフェイスには、主に設定プロバイダーがアプリケーションのバージョンの変更をよりインテリジェントに処理できるようにする3つのメソッドが含まれています。This interface contains three methods that primarily enable the settings provider to more intelligently handle application version changes. 通常、設定プロバイダーは、次の状況を予測するために、異なるバージョンのアプリケーションのアプリケーション設定を個別に格納します。Typically, the settings provider will store application settings for different versions of an application separately to anticipate the following circumstances:

  • アプリケーションの異なるバージョンの side-by-side 実行。Side-by-side execution of different versions of an application.

  • アプリケーションをアップグレードするときに、アプリケーションの設定を保持します。Retaining application settings when upgrading an application.

  • 現在使用されているバージョンのアプリケーション設定を既定値にリセットしています。Resetting the application settings to their default values for the currently used version.

LocalFileSettingsProvider クラスは、IApplicationSettingsProvider インターフェイスを実装します。The LocalFileSettingsProvider class implements the IApplicationSettingsProvider interface. に含まれる同じメソッドのセットIApplicationSettingsProviderApplicationSettingsBaseクラスにあります。これにより、アプリケーション設定ラッパーとその設定プロバイダーの間で定義済みの通信チャネルを確立することができます。The same set of methods contained by IApplicationSettingsProvider is also found in the ApplicationSettingsBase class, enabling the establishment of a predefined communication channel between an application settings wrapper and its settings provider.

注意

このインターフェイスは省略可能です。This interface is optional. プロバイダーがこのインターフェイスを実装していない場合、このインターフェイスで定義されているいずれかのメソッドにアクセスしようとすると、設定インフラストラクチャが通知なしに失敗します。If a provider does not implement this interface, the settings infrastructure will fail without notification if it attempts to access any of the methods defined by this interface.

メソッド

GetPreviousVersion(SettingsContext, SettingsProperty) GetPreviousVersion(SettingsContext, SettingsProperty) GetPreviousVersion(SettingsContext, SettingsProperty) GetPreviousVersion(SettingsContext, SettingsProperty)

同じアプリケーションの前のバージョンの、指定した設定プロパティの値を返します。Returns the value of the specified settings property for the previous version of the same application.

Reset(SettingsContext) Reset(SettingsContext) Reset(SettingsContext) Reset(SettingsContext)

指定したアプリケーションに関連付けられたアプリケーション設定を、その既定値にリセットします。Resets the application settings associated with the specified application to their default values.

Upgrade(SettingsContext, SettingsPropertyCollection) Upgrade(SettingsContext, SettingsPropertyCollection) Upgrade(SettingsContext, SettingsPropertyCollection) Upgrade(SettingsContext, SettingsPropertyCollection)

アプリケーションがアップグレードされたことをプロバイダーに示します。Indicates to the provider that the application has been upgraded. これにより、プロバイダーは格納している値を必要に応じてアップグレードできます。This offers the provider an opportunity to upgrade its stored settings as appropriate.

適用対象

こちらもご覧ください