XmlSerializer.Serialize Method (Stream, Object, XmlSerializerNamespaces)


Serializes the specified Object and writes the XML document to a file using the specified Streamthat references the specified namespaces.

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

member Serialize : 
        stream:Stream *
        o:Object *
        namespaces:XmlSerializerNamespaces -> unit


Type: System.IO.Stream

The Stream used to write the XML document.

Type: System.Object

The Object to serialize.

Type: System.Xml.Serialization.XmlSerializerNamespaces

The XmlSerializerNamespaces referenced by the object.

Exception Condition

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 stream parameter to specify an object that derives from the abstract Stream class, which is designed to write to streams. Classes that derive from the Stream class include:


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

The following example serializes an object with a Stream object. The example also creates an XmlSerializerNamespaces and adds two namespaces to the object. The class that defines the serialized object is also attributed with XmlElementAttribute attributes to specify the namespace for each element.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top