SettingsSerializeAsAttribute Class

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Specifies the serialization mechanism that the settings provider should use. This class cannot be inherited.

public ref class SettingsSerializeAsAttribute sealed : Attribute

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

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

Public NotInheritable Class SettingsSerializeAsAttribute
Inherits Attribute

Inheritance

Object

Attribute

SettingsSerializeAsAttribute

Attributes

AttributeUsageAttribute

Remarks

A settings provider often supports more than one of the .NET Framework standard serialization schemes. These schemes are outlined by the SettingsSerializeAs enumeration, and include plain text, XML, and binary serialization. In addition, a provider may optionally support a custom serialization scheme.

With the SettingsSerializeAsAttribute, you can specify which serialization mechanism should be used for a given application settings class or property. This attribute is considered a request to the settings provider. It may be ignored or cause an error if the provider or the individual property type does not support the specified serialization scheme. If this attribute is not present, the provider will usually provide a default serialization mechanism, most commonly plain text.

Although the settings provider may provide a way to dynamically change the serialization mechanism during run time, this is not a typical capability.

Constructors

SettingsSerializeAsAttribute(SettingsSerializeAs)

Initializes an instance of the SettingsSerializeAsAttribute class.

Properties

SerializeAs	Gets the SettingsSerializeAs enumeration value that specifies the serialization scheme.
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
• SettingsSerializeAs
• SerializeAs
• SerializeAs
• ISettingsProviderService