Export (0) Print
Expand All

XmlSerializer.Deserialize Method (TextReader)

Deserializes the XML document contained by the specified TextReader.

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

'Declaration
Public Function Deserialize ( _
	textReader As TextReader _
) As Object

Parameters

textReader
Type: System.IO.TextReader

The TextReader that contains the XML document to deserialize.

Return Value

Type: System.Object
The Object being deserialized.

ExceptionCondition
InvalidOperationException

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

Deserialization is the process of reading an instance of an XML document and constructing an object that is strongly typed to the XML Schema (XSD) of the document.

Before deserializing, an XmlSerializer must be constructed using the type of the object that is being deserialized.

Classes that inherit from TextReader include StringReader and StreamReader. If you are using a StreamReader to deserialize an object, you must construct the StreamReader with an appropriate Encoding. The encoding specified by the XML document is ignored.

NoteNote

To use the encoding specified by the XML document, use the Deserialize overload that takes an XmlReader instead. The XmlReader automatically detects and uses the encoding specified by the XML document.

NoteNote

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

The following example deserializes an object using a TextReader object.

Imports System
Imports System.IO
Imports System.Text
Imports System.Xml.Serialization
Imports Microsoft.VisualBasic

' This is the class that will be deserialized. 
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()
        ' Read a purchase order.
        t.DeserializeObject("simple.xml")
    End Sub 

    Private Sub DeserializeObject(filename As String)
        Console.WriteLine("Reading with TextReader")

        ' Create an instance of the XmlSerializer specifying type. 
        Dim serializer As New XmlSerializer(GetType(OrderedItem))

        ' Create a TextReader to read the file.  
        Dim fs as New FileStream(filename, FileMode.OpenOrCreate)
        Dim reader As New StreamReader(fs)

        ' Declare an object variable of the type to be deserialized. 
        Dim i As OrderedItem

        ' Use the Deserialize method to restore the object's state.
        i = CType(serializer.Deserialize(reader), OrderedItem)

        ' Write out the properties of the object.
        Console.Write(i.ItemName & ControlChars.Tab & _
                      i.Description & ControlChars.Tab & _
                      i.UnitPrice & ControlChars.Tab & _
                      i.Quantity & ControlChars.Tab & _
                      i.LineTotal)
    End Sub 
End Class

.NET Framework

Supported in: 4.5.2, 4.5.1, 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

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Show:
© 2014 Microsoft