NoSettingsVersionUpgradeAttribute Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

NoSettingsVersionUpgradeAttribute.cs

Specifies that a settings provider should disable any logic that gets invoked when an application upgrade is detected. This class cannot be inherited.

public ref class NoSettingsVersionUpgradeAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property)]
public sealed class NoSettingsVersionUpgradeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property)>]
type NoSettingsVersionUpgradeAttribute = class
    inherit Attribute

Public NotInheritable Class NoSettingsVersionUpgradeAttribute
Inherits Attribute

Inheritance

Object

Attribute

NoSettingsVersionUpgradeAttribute

Attributes

AttributeUsageAttribute

Remarks

To create a fully featured application settings provider that supports application versioning, the provider must implement the IApplicationSettingsProvider interface. One of the members in this interface, the Upgrade method, is called to notify the provider that a new version of the application has been installed. In response, the provider is expected to perform an appropriate action, typically migrating past application settings.

The NoSettingsVersionUpgradeAttribute informs the provider to suppress the upgrade logic associated with the current settings class. Therefore, the value of the previous version of this property group should not be migrated to the new installation.

Note

This attribute can only be applied to individual application settings properties.

Constructors

Name	Description
NoSettingsVersionUpgradeAttribute()	Initializes a new instance of the NoSettingsVersionUpgradeAttribute class.

See also

• IApplicationSettingsProvider
• Upgrade(SettingsContext, SettingsPropertyCollection)