NoSettingsVersionUpgradeAttribute Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

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

NoSettingsVersionUpgradeAttribute()

Initializes a new instance of the NoSettingsVersionUpgradeAttribute class.

Properties

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• IApplicationSettingsProvider
• Upgrade(SettingsContext, SettingsPropertyCollection)