XmlSerializer.Serialize Method (Stream, Object)


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

Serializes the specified Object and writes the XML document to a file using the specified Stream.

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

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


Type: System.IO.Stream

The Stream used to write the XML document.

Type: System.Object

The Object to serialize.

Exception Condition

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

The Serialize method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. To serialize all of an object's fields and properties, both public and private, use the BinaryFormatter.

In the stream parameter, specify an object that derives from the abstract Stream class. Classes that derive from Stream include:


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

The following example serializes an object using a Stream object.

No code example is currently available or this language may not be supported.
<?xml version="1.0"?>
 <OrderedItem xmlns:inventory="http://www.cpandl.com" xmlns:money="http://www.cohowinery.com">
   <inventory:Description>Regular Widget</inventory:Description>

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