Edit

Share via


ApplicationSettingsBase.Upgrade Method

Definition

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 ()

Exceptions

The configuration file could not be parsed.

Remarks

The Upgrade method performs two actions to assure smooth transition to a new version of an application:

You can override the default behavior of Upgrade to implement custom upgrading or merging behavior. Use the GetPreviousVersion method to retrieve individual values for a setting for the previous version of the application. Examples of custom upgrade behavior include:

  • 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.

Applies to

See also