System.Xml.Serialization Namespace
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

The System.Xml.Serialization namespace contains classes that are used to serialize objects into XML format documents or streams.

ClassDescription
System_CAPS_pubclass CodeExporter

Represents a class that can generate proxy code from an XML representation of a data structure.

System_CAPS_pubclass CodeIdentifier

This API supports the product infrastructure and is not intended to be used directly from your code. Provides static methods to convert input text into names for code entities.

System_CAPS_pubclass CodeIdentifiers

This API supports the product infrastructure and is not intended to be used directly from your code. Maintains a group of names for related code entities or type mappings that are generated by the .NET Framework's XML serialization infrastructure.

System_CAPS_protclass XmlSerializationReaderCollectionFixup

Holds an XmlSerializationCollectionFixupCallback delegate instance, plus the method's inputs; also supplies the method's parameters.

System_CAPS_protclass XmlSerializationReaderFixup

This API supports the product infrastructure and is not intended to be used directly from your code. Holds an XmlSerializationFixupCallback delegate instance, plus the method's inputs; also serves as the parameter for the method.

System_CAPS_pubclass ImportContext

This API supports the product infrastructure and is not intended to be used directly from your code. Describes the context in which a set of schema is bound to .NET Framework code entities.

System_CAPS_pubclass SchemaImporter

Describes a schema importer.

System_CAPS_pubclass SoapAttributeAttribute

Specifies that the XmlSerializer must serialize the class member as an encoded SOAP attribute.

System_CAPS_pubclass SoapAttributeOverrides

Allows you to override attributes applied to properties, fields, and classes when you use an XmlSerializer to serialize or deserialize an object as encoded SOAP.

System_CAPS_pubclass SoapAttributes

Represents a collection of attribute objects that control how the XmlSerializer serializes and deserializes SOAP methods.

System_CAPS_pubclass SoapCodeExporter

This API supports the product infrastructure and is not intended to be used directly from your code. Generates types and attribute declarations from internal type mapping information for SOAP-encoded message parts defined in a WSDL document.

System_CAPS_pubclass SoapElementAttribute

Specifies that the public member value be serialized by the XmlSerializer as an encoded SOAP XML element.

System_CAPS_pubclass SoapEnumAttribute

Controls how the XmlSerializer serializes an enumeration member.

System_CAPS_pubclass SoapIgnoreAttribute

Instructs the XmlSerializer not to serialize the public field or public read/write property value.

System_CAPS_pubclass SoapIncludeAttribute

Allows the XmlSerializer to recognize a type when it serializes or deserializes an object as encoded SOAP XML.

System_CAPS_pubclass SoapReflectionImporter

Generates mappings to SOAP-encoded messages from .NET Framework types or Web service method information.

System_CAPS_pubclass SoapSchemaExporter

This API supports the product infrastructure and is not intended to be used directly from your code. Populates XmlSchema objects with XML Schema data type definitions for .NET Framework types that are serialized using SOAP encoding.

System_CAPS_pubclass SoapSchemaImporter

This API supports the product infrastructure and is not intended to be used directly from your code. Used within the .NET Framework to generate internal mappings to .NET Framework types for SOAP-encoded message parts in a WSDL document.

System_CAPS_pubclass SoapSchemaMember

This API supports the product infrastructure and is not intended to be used directly from your code. Represents certain attributes of a XSD <part> element in a WSDL document for generating classes from the document.

System_CAPS_pubclass SoapTypeAttribute

Controls the schema generated by the XmlSerializer when a class instance is serialized as SOAP encoded XML.

System_CAPS_pubclass UnreferencedObjectEventArgs

Provides data for the known, but unreferenced, object found in an encoded SOAP XML stream during deserialization.

System_CAPS_pubclass XmlAnyAttributeAttribute

Specifies that the member (a field that returns an array of XmlAttribute objects) can contain any XML attributes.

System_CAPS_pubclass XmlAnyElementAttribute

Specifies that the member (a field that returns an array of XmlElement or XmlNode objects) contains objects that represent any XML element that has no corresponding member in the object being serialized or deserialized.

System_CAPS_pubclass XmlAnyElementAttributes

Represents a collection of XmlAnyElementAttribute objects.

System_CAPS_pubclass XmlArrayAttribute

Specifies that the XmlSerializer must serialize a particular class member as an array of XML elements.

System_CAPS_pubclass XmlArrayItemAttribute

Represents an attribute that specifies the derived types that the XmlSerializer can place in a serialized array.

System_CAPS_pubclass XmlArrayItemAttributes

Represents a collection of XmlArrayItemAttribute objects.

System_CAPS_pubclass XmlAttributeAttribute

Specifies that the XmlSerializer must serialize the class member as an XML attribute.

System_CAPS_pubclass XmlAttributeEventArgs

Provides data for the UnknownAttribute event.

System_CAPS_pubclass XmlAttributeOverrides

Allows you to override property, field, and class attributes when you use the XmlSerializer to serialize or deserialize an object.

System_CAPS_pubclass XmlAttributes

Represents a collection of attribute objects that control how the XmlSerializer serializes and deserializes an object.

System_CAPS_pubclass XmlChoiceIdentifierAttribute

Specifies that the member can be further detected by using an enumeration.

System_CAPS_pubclass XmlCodeExporter

This API supports the product infrastructure and is not intended to be used directly from your code. Generates types and attribute declarations from internal type mapping information for XML schema element declarations.

System_CAPS_pubclass XmlElementAttribute

Indicates that a public field or property represents an XML element when the XmlSerializer serializes or deserializes the object that contains it.

System_CAPS_pubclass XmlElementAttributes

Represents a collection of XmlElementAttribute objects used by the XmlSerializer to override the default way it serializes a class.

System_CAPS_pubclass XmlElementEventArgs

Provides data for the UnknownElement event.

System_CAPS_pubclass XmlEnumAttribute

Controls how the XmlSerializer serializes an enumeration member.

System_CAPS_pubclass XmlIgnoreAttribute

Instructs the Serialize method of the XmlSerializer not to serialize the public field or public read/write property value.

System_CAPS_pubclass XmlIncludeAttribute

Allows the XmlSerializer to recognize a type when it serializes or deserializes an object.

System_CAPS_pubclass XmlMapping

This API supports the product infrastructure and is not intended to be used directly from your code. Supports mappings between .NET Framework types and XML Schema data types.

System_CAPS_pubclass XmlMemberMapping

This API supports the product infrastructure and is not intended to be used directly from your code. Maps a code entity in a .NET Framework Web service method to an element in a Web Services Description Language (WSDL) message.

System_CAPS_pubclass XmlMembersMapping

This API supports the product infrastructure and is not intended to be used directly from your code. Provides mappings between .NET Framework Web service methods and Web Services Description Language (WSDL) messages that are defined for SOAP Web services.

System_CAPS_pubclass XmlNamespaceDeclarationsAttribute

Specifies that the target property, parameter, return value, or class member contains prefixes associated with namespaces that are used within an XML document.

System_CAPS_pubclass XmlNodeEventArgs

Provides data for the UnknownNode event.

System_CAPS_pubclass XmlReflectionImporter

This API supports the product infrastructure and is not intended to be used directly from your code. Generates mappings to XML schema element declarations, including literal XML Schema Definition (XSD) message parts in a Web Services Description Language (WSDL) document, for .NET Framework types or Web service method information.

System_CAPS_pubclass XmlReflectionMember

This API supports the product infrastructure and is not intended to be used directly from your code. Provides mappings between code entities in .NET Framework Web service methods and the content of Web Services Description Language (WSDL) messages that are defined for SOAP Web services.

System_CAPS_pubclass XmlRootAttribute

Controls XML serialization of the attribute target as an XML root element.

System_CAPS_pubclass XmlSchemaEnumerator

Enables iteration over a collection of XmlSchema objects.

System_CAPS_pubclass XmlSchemaExporter

This API supports the product infrastructure and is not intended to be used directly from your code. Populates XmlSchema objects with XML schema element declarations that are found in type mapping objects.

System_CAPS_pubclass XmlSchemaImporter

This API supports the product infrastructure and is not intended to be used directly from your code. Generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document.

System_CAPS_pubclass XmlSchemaProviderAttribute

When applied to a type, stores the name of a static method of the type that returns an XML schema and a XmlQualifiedName (or XmlSchemaType for anonymous types) that controls the serialization of the type.

System_CAPS_pubclass XmlSchemas

This API supports the product infrastructure and is not intended to be used directly from your code. Represents the collection of XML schemas.

System_CAPS_pubclass XmlSerializationGeneratedCode

This API supports the product infrastructure and is not intended to be used directly from your code. An abstract class that is the base class for XmlSerializationReader and XmlSerializationWriter and that contains methods common to both of these types.

System_CAPS_pubclass XmlSerializationReader

This API supports the product infrastructure and is not intended to be used directly from your code. Controls deserialization by the XmlSerializer class.

System_CAPS_pubclass XmlSerializationWriter

This API supports the product infrastructure and is not intended to be used directly from your code. Represents an abstract class used for controlling serialization by the XmlSerializer class.

System_CAPS_pubclass XmlSerializer

Serializes and deserializes objects into and from XML documents. The XmlSerializer enables you to control how objects are encoded into XML.

System_CAPS_pubclass XmlSerializerAssemblyAttribute

Applied to a Web service client proxy, enables you to specify an assembly that contains custom-made serializers.

System_CAPS_pubclass XmlSerializerFactory

This API supports the product infrastructure and is not intended to be used directly from your code. Creates typed versions of the XmlSerializer for more efficient serialization.

System_CAPS_pubclass XmlSerializerImplementation

This API supports the product infrastructure and is not intended to be used directly from your code. Defines the reader, writer, and methods for pre-generated, typed serializers.

System_CAPS_pubclass XmlSerializerNamespaces

Contains the XML namespaces and prefixes that the XmlSerializer uses to generate qualified names in an XML-document instance.

System_CAPS_pubclass XmlSerializerVersionAttribute

Signifies that the code was generated by the serialization infrastructure and can be reused for increased performance, when this attribute is applied to an assembly.

System_CAPS_pubclass XmlTextAttribute

Indicates to the XmlSerializer that the member must be treated as XML text when the class that contains it is serialized or deserialized.

System_CAPS_pubclass XmlTypeAttribute

Controls the XML schema that is generated when the attribute target is serialized by the XmlSerializer.

System_CAPS_pubclass XmlTypeMapping

Contains a mapping of one type to another.

StructureDescription
System_CAPS_pubstructure XmlDeserializationEvents

Contains fields that can be used to pass event delegates to a thread-safe Deserialize method of the XmlSerializer.

InterfaceDescription
System_CAPS_pubinterface IXmlSerializable

Provides custom formatting for XML serialization and deserialization.

System_CAPS_pubinterface IXmlTextParser

This API supports the product infrastructure and is not intended to be used directly from your code. Establishes a property for use by the .NET Framework infrastructure.

DelegateDescription
System_CAPS_pubdelegate UnreferencedObjectEventHandler

Represents the method that handles the UnreferencedObject event of an XmlSerializer.

System_CAPS_pubdelegate XmlAttributeEventHandler

Represents the method that handles the UnknownAttribute

System_CAPS_pubdelegate XmlElementEventHandler

Represents the method that handles the UnknownElement event of an XmlSerializer.

System_CAPS_pubdelegate XmlNodeEventHandler

Represents the method that handles the UnknownNode event of an XmlSerializer.

System_CAPS_pubdelegate XmlSerializationCollectionFixupCallback

This API supports the product infrastructure and is not intended to be used directly from your code. Delegate used by the XmlSerializer class for deserialization of SOAP-encoded XML data types that map to collections or enumerations.

System_CAPS_pubdelegate XmlSerializationFixupCallback

This API supports the product infrastructure and is not intended to be used directly from your code. Delegate used by the XmlSerializer class for deserialization of SOAP-encoded XML data.

System_CAPS_pubdelegate XmlSerializationReadCallback

This API supports the product infrastructure and is not intended to be used directly from your code. Delegate used by the XmlSerializer class for deserialization of types from SOAP-encoded, non-root XML data.

System_CAPS_pubdelegate XmlSerializationWriteCallback

This API supports the product infrastructure and is not intended to be used directly from your code. Delegate that is used by the XmlSerializer class for serialization of types from SOAP-encoded, non-root XML data.

EnumerationDescription
System_CAPS_pubenum CodeGenerationOptions

Specifies various options to use when generating .NET Framework types for use with an XML Web Service.

System_CAPS_pubenum XmlMappingAccess

This API supports the product infrastructure and is not intended to be used directly from your code. Specifies whether a mapping is read, write, or both.

The central class in the namespace is the XmlSerializer class. To use this class, use the XmlSerializer constructor to create an instance of the class using the type of the object to serialize. Once an XmlSerializer is created, create an instance of the object to serialize. You must also create an object to write the file to a document or stream, such as a Stream, TextWriter, or XmlWriter. You can then call the Serialize method to convert the object into an XML document.

To deserialize an object from an XML document, create a suitable object to read the document or stream (again, a Stream, TextWriter, or XmlWriter). Invoke the Deserialize method while casting the resulting object to the type of the original object (that was serialized).

To further control the serialization, the System.Xml.Serialization namespace contains several Attribute classes that can be applied to members of a class. For example, if a class contains a member that will be serialized as an XML element, you can apply the XmlElementAttribute attribute to the member. When applying the attribute, you can specify details such as the actual XML element name using the property. For a complete list of all the attributes, see the XmlSerializer class overview.

Return to top