SettingsProviderAttribute Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Source:

SettingsProviderAttribute.cs

Specifies the settings provider used to provide storage for the current application settings class or property. This class cannot be inherited.

public ref class SettingsProviderAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Property)]
public sealed class SettingsProviderAttribute : Attribute

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

Public NotInheritable Class SettingsProviderAttribute
Inherits Attribute

Inheritance

Object

Attribute

SettingsProviderAttribute

Attributes

AttributeUsageAttribute

Remarks

Each application settings class defines a group of application settings properties that represent information that persists between executions of the application. However, it is a settings provider - a class derived from SettingsProvider - that actually provides the storage mechanism.

The SettingsProviderAttribute specifies the settings provider used to provide storage for application settings properties. This attribute can be applied to the entire application settings class or individual application settings properties. A SettingsProviderAttribute set at the property level will override the class-level attribute. If a settings provider is not explicitly specified, the default provider is used. For client applications, the default provider is LocalFileSettingsProvider.

Setting providers cannot be determined at run time. Any run-time determination of storage methods must be coded into the settings provider class itself.

Caution

Using custom settings providers from arbitrary third parties is inherently unsafe because these providers have full read/write access to your application's configuration information. A settings provider should be thoroughly vetted before it is adopted for general use.

Constructors

SettingsProviderAttribute(String)	Initializes an instance of the SettingsProviderAttribute class.
SettingsProviderAttribute(Type)	Initializes a new instance of the SettingsProviderAttribute class.

Properties

ProviderTypeName	Gets the type name of the settings provider.
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

• SettingsProvider
• SettingsBase
• Application Settings Architecture