XmlSerializer.Deserialize Method (TextReader) (System.Xml.Serialization)

Switch View :
ScriptFree
.NET Framework Class Library
XmlSerializer.Deserialize Method (TextReader)

Deserializes the XML document contained by the specified TextReader.

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

Visual Basic
Public Function Deserialize ( _
	textReader As TextReader _
) As Object
C#
public Object Deserialize(
	TextReader textReader
)
Visual C++
public:
Object^ Deserialize(
	TextReader^ textReader
)
F#
member Deserialize : 
        textReader:TextReader -> 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.
Exceptions

Exception Condition
InvalidOperationException

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

Remarks

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.

Note Note

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.

Note Note

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

Examples

The following example deserializes an object using a TextReader object.

Visual Basic

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


C#

using System;
using System.IO;
using System.Text;
using System.Xml.Serialization;

// This is the class that will be deserialized.
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()
   {
      Test t = new Test();
      // Read a purchase order.
      t.DeserializeObject("simple.xml");
   }
   private void DeserializeObject(string filename)
   {   
      Console.WriteLine("Reading with TextReader");

      // Create an instance of the XmlSerializer specifying type.
      XmlSerializer serializer = 
      new XmlSerializer(typeof(OrderedItem));

      // Create a TextReader to read the file. 
      FileStream fs = new FileStream(filename, FileMode.OpenOrCreate);
      TextReader reader = new StreamReader(fs);

      // Declare an object variable of the type to be deserialized.
      OrderedItem i;

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

      // Write out the properties of the object.
      Console.Write(
      i.ItemName + "\t" +
      i.Description + "\t" +
      i.UnitPrice + "\t" +
      i.Quantity + "\t" +
      i.LineTotal);
   }
}


Visual C++

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Text;
using namespace System::Xml::Serialization;

// This is the class that will be deserialized.
public ref class OrderedItem
{
public:
   String^ ItemName;
   String^ Description;
   Decimal UnitPrice;
   int Quantity;
   Decimal LineTotal;

   // A custom method used to calculate price per item.
   void Calculate()
   {
      LineTotal = UnitPrice * Quantity;
   }
};

void DeserializeObject( String^ filename )
{
   Console::WriteLine( "Reading with TextReader" );

   // Create an instance of the XmlSerializer specifying type.
   XmlSerializer^ serializer = gcnew XmlSerializer( OrderedItem::typeid );

   /* Create a TextReader to read the file. Specify an
      Encoding to use. */
   TextReader^ reader = gcnew StreamReader( filename,Encoding::Unicode );

   // Declare an object variable of the type to be deserialized.
   OrderedItem^ i;

   // Use the Deserialize method to restore the object's state.
   i = dynamic_cast<OrderedItem^>(serializer->Deserialize( reader ));

   // Write out the properties of the object.
   Console::Write( "{0}\t{1}\t{2}\t{3}\t{4}", i->ItemName, i->Description, i->UnitPrice, i->Quantity, i->LineTotal );
}

int main()
{
   // Read a purchase order.
   DeserializeObject( "simple.xml" );
}


Version Information

.NET Framework

Supported in: 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
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

Other Resources

Community Content

Andre Juliano
Missing Contents of "simple.xml"
The "simple.xml" can be get from Serialize() method sample in http://msdn.microsoft.com/en-us/library/d15aekdk.aspx.

theBoringCoder at work
Missing Contents of Simple.xml
How about including the contents of simple.xml?