Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SettingsSerializeAsAttribute Class
Collapse the table of content
Expand the table of content

SettingsSerializeAsAttribute Class

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

System.Object
  System.Attribute
    System.Configuration.SettingsSerializeAsAttribute

Namespace:  System.Configuration
Assembly:  System (in System.dll)

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Property)>]
type SettingsSerializeAsAttribute =  
    class
        inherit Attribute
    end

The SettingsSerializeAsAttribute type exposes the following members.

  NameDescription
Public methodSettingsSerializeAsAttributeInitializes an instance of the SettingsSerializeAsAttribute class.
Top

  NameDescription
Public propertySerializeAsGets the SettingsSerializeAs enumeration value that specifies the serialization scheme.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2015 Microsoft