ApplicationSettingsBase.Upgrade Method
Updates application settings to reflect a more recent installation of the application.
Namespace: System.Configuration
Assembly: System (in System.dll)
| Exception | Condition |
|---|---|
| ConfigurationErrorsException | The configuration file could not be parsed. |
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.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.