This documentation is archived and is not being maintained.

XmlSerializer.Serialize Method (XmlWriter, Object, XmlSerializerNamespaces, String)

Serializes the specified object and writes the XML document to a file using the specified XmlWriter and references the specified namespaces and encoding style.

Namespace:  System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)

public void Serialize(
	XmlWriter xmlWriter,
	Object o,
	XmlSerializerNamespaces namespaces,
	string encodingStyle
)

Parameters

xmlWriter
Type: System.Xml.XmlWriter
The XmlWriter used to write the XML document.
o
Type: System.Object
The object to serialize.
namespaces
Type: System.Xml.Serialization.XmlSerializerNamespaces
The XmlSerializerNamespaces referenced by the object.
encodingStyle
Type: System.String
The encoding style of the serialized XML.

ExceptionCondition
InvalidOperationException

An error occurred during serialization. The original exception is available using the InnerException property.

When the Serialize method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. To serialize all fields and properties, both public and private, use the BinaryFormatter.

Use the xmlWriter parameter to specify an object that derives from the abstract XmlWriter class, which is designed to write XML documents. The XmlTextWriter derives from the XmlWriter.

Set the encodingStyle parameter to "http://schemas.xmlsoap.org/soap/encoding/" for SOAP version 1.1 encoding; otherwise, set it to "http://www.w3.org/2001/12/soap-encoding" for SOAP version 1.2 encoding.

NoteNote

The XmlSerializer cannot serialize the following: arrays of ArrayList and arrays of List<T>.

.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.
Show: