ApplicationSettingsBase.Upgrade Method (System.Configuration)

Upgrade Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

ApplicationSettingsBase..::.Upgrade Method

Updated: November 2007

Updates application settings to reflect a more recent installation of the application.

Namespace: System.Configuration
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

Public Overridable Sub Upgrade

Visual Basic (Usage)

Dim instance As ApplicationSettingsBase

instance.Upgrade()

public virtual void Upgrade()

Visual C++

public:
virtual void Upgrade()

public void Upgrade()

JScript

public function Upgrade()

Remarks

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

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. This action is not performed if the settings wrapper class is marked with NoSettingsVersionUpgradeAttribute.
It reloads the values for all of the application settings.

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.

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information