XmlSerializer.Serialize Method (TextWriter, Object, XmlSerializerNamespaces)
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)
public void Serialize( TextWriter textWriter, Object o, XmlSerializerNamespaces namespaces )
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:
 Note |
|---|
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.
using System; using System.IO; using System.Xml.Serialization; // This is the class that will be serialized. public class OrderedItem { [XmlElement(Namespace = "http://www.cpandl.com")] public string ItemName; [XmlElement(Namespace = "http://www.cpandl.com")] public string Description; [XmlElement(Namespace="http://www.cohowinery.com")] public decimal UnitPrice; [XmlElement(Namespace = "http://www.cpandl.com")] public int Quantity; [XmlElement(Namespace="http://www.cohowinery.com")] public decimal LineTotal; // A custom method used to calculate price per item. public void Calculate() { LineTotal = UnitPrice * Quantity; } } public class Test{ public static void Main(string[] args) { Test t = new Test(); // Write a purchase order. t.SerializeObject("simple.xml"); } private void SerializeObject(string filename) { Console.WriteLine("Writing With TextWriter"); // Create an XmlSerializer instance using the type. XmlSerializer serializer = new XmlSerializer(typeof(OrderedItem)); OrderedItem i = new OrderedItem(); i.ItemName = "Widget"; i.Description = "Regular Widget"; i.Quantity = 10; i.UnitPrice = (decimal) 2.30; i.Calculate(); // Create an XmlSerializerNamespaces object. XmlSerializerNamespaces ns = new XmlSerializerNamespaces(); // Add two namespaces with prefixes. ns.Add("inventory", "http://www.cpandl.com"); ns.Add("money", "http://www.cohowinery.com"); // Create a StreamWriter to write with. TextWriter writer = new StreamWriter(filename); /* Serialize using the object using the TextWriter and namespaces. */ serializer.Serialize(writer, i, ns); writer.Close(); } }
<?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>
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
