SettingsSerializeAsAttribute Class (System.Configuration)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SettingsSerializeAsAttribute Class

Updated: November 2007

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

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

Syntax

Visual Basic (Declaration)

<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Property)> _
Public NotInheritable Class SettingsSerializeAsAttribute _
    Inherits Attribute

Visual Basic (Usage)

Dim instance As SettingsSerializeAsAttribute

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

Visual C++

[AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Property)]
public ref class SettingsSerializeAsAttribute sealed : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Property) */
public final class SettingsSerializeAsAttribute extends Attribute

JScript

public final class SettingsSerializeAsAttribute extends Attribute

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.

Inheritance Hierarchy

System..::.Object
System..::.Attribute
System.Configuration..::.SettingsSerializeAsAttribute

Thread Safety

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

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information