XmlSerializer.Serialize Method (TextWriter, Object, XmlSerializerNamespaces)

 
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.

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

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

member Serialize : 
        textWriter:TextWriter *
        o:Object *
        namespaces:XmlSerializerNamespaces -> unit

Parameters

textWriter
Type: System.IO.TextWriter

The TextWriter used to write the XML document.

o
Type: System.Object

The Object to serialize.

namespaces
Type: System.Xml.Serialization.XmlSerializerNamespaces

The XmlSerializerNamespaces that contains namespaces for the generated XML document.

Exception Condition
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 textWriter parameter to specify an object that derives from the abstract TextWriter class. Classes that derive from TextWriter class include:

System_CAPS_noteNote

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

The following example serializes an object with a TextWriter. The example also creates an XmlSerializerNamespaces object 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.
<?xml version="1.0"?>
 <OrderedItem xmlns:inventory="http://www.cpandl.com" xmlns:money="http://www.cohowinery.com">
   <inventory:ItemName>Widget</inventory:ItemName>
   <inventory:Description>Regular Widget</inventory:Description>
   <money:UnitPrice>2.3</money:UnitPrice>
   <inventory:Quantity>10</inventory:Quantity>
   <money:LineTotal>23</money:LineTotal>
 </OrderedItem>

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