This documentation is archived and is not being maintained.

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)

'Declaration
Public Sub Serialize ( _
	textWriter As TextWriter, _
	o As Object, _
	namespaces As XmlSerializerNamespaces _
)
'Usage
Dim instance As XmlSerializer
Dim textWriter As TextWriter
Dim o As Object
Dim namespaces As XmlSerializerNamespaces

instance.Serialize(textWriter, o, namespaces)
public void Serialize (
	TextWriter textWriter, 
	Object o, 
	XmlSerializerNamespaces namespaces
)
public function Serialize (
	textWriter : TextWriter, 
	o : Object, 
	namespaces : XmlSerializerNamespaces
)
Not applicable.

Parameters

textWriter

The TextWriter used to write the XML document.

o

The Object to serialize.

namespaces

The XmlSerializerNamespaces that contains namespaces for the generated XML document.

Exception typeCondition

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:

NoteNote:

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

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.

Imports System
Imports System.IO
Imports System.Xml.Serialization


' This is the class that will be serialized.
Public Class OrderedItem
    <XmlElement(Namespace := "http://www.cpandl.com")> _
    Public ItemName As String
    
    <XmlElement(Namespace := "http://www.cpandl.com")> _
    Public Description As String
    
    <XmlElement(Namespace := "http://www.cohowinery.com")> _
    Public UnitPrice As Decimal
    
    <XmlElement(Namespace := "http://www.cpandl.com")> _
    Public Quantity As Integer
    
    <XmlElement(Namespace := "http://www.cohowinery.com")> _
    Public LineTotal As Decimal
    
    'A custom method used to calculate price per item.
    Public Sub Calculate()
        LineTotal = UnitPrice * Quantity
    End Sub
End Class


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        ' Write a purchase order.
        t.SerializeObject("simple.xml")
    End Sub
    
    Private Sub SerializeObject(ByVal filename As String)
        Console.WriteLine("Writing With TextWriter")
        ' Create an XmlSerializer instance using the type.
        Dim serializer As New XmlSerializer(GetType(OrderedItem))
        Dim i As New OrderedItem()
        i.ItemName = "Widget"
        i.Description = "Regular Widget"
        i.Quantity = 10
        i.UnitPrice = CDec(2.3)
        i.Calculate()
        
        ' Create an XmlSerializerNamespaces object.
        Dim ns As 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.
        Dim writer As New StreamWriter(filename)
        ' Serialize using the object using the TextWriter
        ' and namespaces. 
        serializer.Serialize(writer, i, ns)
        writer.Close()
    End Sub
End Class


import System.*;
import System.IO.*;
import System.Xml.Serialization.*;

// This is the class that will be serialized.
public class OrderedItem
{
    /** @attribute XmlElement(Namespace = "http://www.cpandl.com")
     */
    public String itemName;
    /** @attribute XmlElement(Namespace = "http://www.cpandl.com")
     */
    public String description;
    /** @attribute XmlElement(Namespace = "http://www.cohowinery.com")
     */
    public System.Decimal unitPrice;
    /** @attribute XmlElement(Namespace = "http://www.cpandl.com")
     */
    public int quantity;
    /** @attribute XmlElement(Namespace = "http://www.cohowinery.com")
     */
    public System.Decimal lineTotal;

    // A custom method used to calculate price per item.
    public void Calculate()
    {
        lineTotal = Decimal.Multiply(unitPrice, Convert.ToDecimal(quantity));
    } //Calculate
} //OrderedItem

public class Test
{
    public static void main(String[] args)
    {
        Test t = new Test();
        // Write a purchase order.
        t.SerializeObject("simple.xml");
    } //main

    private void SerializeObject(String fileName)
    {
        Console.WriteLine("Writing With TextWriter");

        // Create an XmlSerializer instance using the type.
        XmlSerializer serializer =
            new XmlSerializer(OrderedItem.class.ToType());
        OrderedItem i = new OrderedItem();
        i.itemName = "Widget";
        i.description = "Regular Widget";
        i.quantity = 10;
        i.unitPrice = Convert.ToDecimal(2.3);
        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();
    } //SerializeObject
} //Test

<?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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0
Show: