0 out of 1 rated this helpful - Rate this topic

XmlSerializer.Serialize Method (TextWriter, Object)

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

Namespace:  System.Xml.Serialization
Assembly:  System.Xml (in System.Xml.dll)
'Declaration
Public Sub Serialize ( _
	textWriter As TextWriter, _
	o As Object _
)

Parameters

textWriter
Type: System.IO.TextWriter

The TextWriter used to write the XML document.

o
Type: System.Object

The Object to serialize.

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 an object's fields and properties, both public and private, use the BinaryFormatter.

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

NoteNote

The XmlSerializer cannot serialize the following: arrays of ArrayList and arrays of List(Of T).

The following example serializes an object using a TextWriter.

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


' This is the class that will be serialized. 
Public Class OrderedItem
    Public ItemName As String 
    Public Description As String 
    Public UnitPrice As Decimal 
    Public Quantity As Integer 
    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")

        Dim serializer As New XmlSerializer(GetType(OrderedItem))
        Dim i As New OrderedItem()

        With i
            .ItemName = "Widget"
            .Description = "Regular Widget"
            .Quantity = 10
            .UnitPrice = CDec(2.3)
            .Calculate()
        End With 

        ' Create a StreamWriter to write with. First create a FileStream 
        ' object, and create the StreamWriter specifying an Encoding to use.  
        Dim fs As New FileStream(filename, FileMode.Create)
        Dim writer As New StreamWriter(fs, New UTF8Encoding())
        ' Serialize using the XmlTextWriter.
        serializer.Serialize(writer, i)
        writer.Close()
    End Sub 
End Class
<?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>

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

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.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.