System.Xml.Serialization Namespace

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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. After 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 ElementName property. For a complete list of all the attributes, see the XmlSerializer class overview.

Classes

Class Description
XmlAnyAttributeAttribute Specifies that the member (a field that returns an array of XmlAttribute objects) can contain any XML attributes.
XmlAnyElementAttribute Specifies that the member (a field that returns an array of XElement or XNode objects) contains objects that represent an XML element that has no corresponding member in the object being serialized or deserialized.
XmlAnyElementAttributes Represents a collection of XmlAnyElementAttribute objects.
XmlArrayAttribute Specifies that the XmlSerializer must serialize a particular class member as an array of XML elements.
XmlArrayItemAttribute Specifies the derived types that the XmlSerializer can place in a serialized array.
XmlArrayItemAttributes Represents a collection of XmlArrayItemAttribute objects.
XmlAttributeAttribute Specifies that the XmlSerializer must serialize the class member as an XML attribute.
XmlAttributeOverrides Allows you to override property, field, and class attributes when you use the XmlSerializer to serialize or deserialize an object.
XmlAttributes Represents a collection of attribute objects that control how the XmlSerializer serializes and deserializes an object.
XmlChoiceIdentifierAttribute Specifies that the member can be further detected by using an enumeration.
XmlElementAttribute Indicates that a public field or property represents an XML element when the XmlSerializer serializes or deserializes the object that contains it.
XmlElementAttributes Represents a collection of XmlElementAttribute objects used by the XmlSerializer to override the default way it serializes a class.
XmlEnumAttribute Controls how the XmlSerializer serializes an enumeration member.
XmlIgnoreAttribute Instructs the Serialize method of the XmlSerializer class not to serialize the public field or public read/write property value.
XmlIncludeAttribute Allows the XmlSerializer to recognize a type when it serializes or deserializes an object.
XmlMapping Infrastructure. Supports mappings between .NET Framework types and XML Schema data types.
XmlNamespaceDeclarationsAttribute Specifies that the target property, parameter, return value, or class member contains prefixes associated with namespaces that are used within an XML document.
XmlReflectionImporter Infrastructure. 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.
XmlRootAttribute Controls XML serialization of the attribute target as an XML root element.
XmlSchemaProviderAttribute When applied to a type that implements the IXmlSerializable interface, stores the name of a static method of the type that returns an XML schema and a XmlQualifiedName.
XmlSerializer Serializes and deserializes objects into and from XML documents. The XmlSerializer enables you to control how objects are encoded into XML.
XmlSerializerNamespaces Contains the XML namespaces and prefixes that the XmlSerializer uses to generate qualified names in an XML-document instance.
XmlTextAttribute Indicates to the XmlSerializer that the member must be treated as XML text when the class that contains it is serialized or deserialized.
XmlTypeAttribute Controls the XML schema that is generated when the attribute target is serialized by the XmlSerializer.
XmlTypeMapping Contains a mapping of one type to another.

Interfaces

Interface Description
IXmlSerializable Provides custom formatting for XML serialization and deserialization to control how your object is serialized or deserialized by the XmlSerializer.

Enumerations

Enumeration Description
XmlMappingAccess Infrastructure. Specifies whether a mapping is read, write, or both.