ApplicationSettingsBase.Upgrade メソッド

定義

アプリケーション設定を更新して、アプリケーションの最新のインストールを反映します。Updates application settings to reflect a more recent installation of the application.

public:
 virtual void Upgrade();
public virtual void Upgrade ();
abstract member Upgrade : unit -> unit
override this.Upgrade : unit -> unit
Public Overridable Sub Upgrade ()

例外

構成ファイルを解析できませんでした。The configuration file could not be parsed.

注釈

メソッドUpgradeは、アプリケーションの新しいバージョンへのスムーズな移行を保証するために、次の2つのアクションを実行します。The Upgrade method performs two actions to assure smooth transition to a new version of an application:

  • このIApplicationSettingsProvider.Upgradeメソッドは、インターフェイスがIApplicationSettingsProvider実装されていることを前提として、アップグレードされたアプリケーションが存在することを、そのメソッドの呼び出しによって、対応するすべての設定プロバイダーに通知します。It notifies all of the corresponding settings providers of the existence of the upgraded application through a call to their IApplicationSettingsProvider.Upgrade method, assuming they have implemented the IApplicationSettingsProvider interface. 設定ラッパークラスがでNoSettingsVersionUpgradeAttributeマークされている場合、このアクションは実行されません。This action is not performed if the settings wrapper class is marked with NoSettingsVersionUpgradeAttribute.

  • すべてのアプリケーション設定の値が再読み込みされます。It reloads the values for all of the application settings.

の既定の動作をオーバーライドしUpgradeて、カスタムのアップグレードまたはマージ動作を実装することができます。You can override the default behavior of Upgrade to implement custom upgrading or merging behavior. 以前のGetPreviousVersionバージョンのアプリケーションの設定の個別の値を取得するには、メソッドを使用します。Use the GetPreviousVersion method to retrieve individual values for a setting for the previous version of the application. カスタムアップグレードの動作の例を次に示します。Examples of custom upgrade behavior include:

  • 新しいポリシーの既定値を使用して、以前のユーザー指定値または以前の既定値の1つ以上を上書きします。Using new policy defaults that override one or more of the previous user-specified values or previous defaults.

  • 新しい範囲、異なる設定プロパティグループなどと互換性のある古い値の特殊な変換。Special translation of old values to be compatible with newer ranges, a different settings property group, and so on.

適用対象

こちらもご覧ください