Export (0) Print
Expand All

XmlSerializer.Deserialize Method (Stream)

Deserializes the XML document contained by the specified Stream.

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

public Object Deserialize (
	Stream stream
)
public Object Deserialize (
	Stream stream
)
public function Deserialize (
	stream : Stream
) : Object
Not applicable.

Parameters

stream

The Stream that contains the XML document to deserialize.

Return Value

The Object being deserialized.

Deserialization is the process of reading 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.

Use the stream parameter to specify an object that derives from the Stream class, which is designed to write to streams. Classes that derive from the Stream class include:

NoteNote:

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

The following example deserializes an object using a Stream object.

using System;
using System.IO;
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 Stream");
      // Create an instance of the XmlSerializer.
      XmlSerializer serializer = 
      new XmlSerializer(typeof(OrderedItem));
      // Reading the XML document requires a FileStream.
      Stream reader= new FileStream(filename,FileMode.Open);
          
      // Declare an object variable of the type to be deserialized.
      OrderedItem i;

      // Call 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);
   }
}


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

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

    private void DeserializeObject(String fileName)
    {
        Console.WriteLine("Reading with Stream");

        // Create an instance of the XmlSerializer.
        XmlSerializer serializer =
            new XmlSerializer(OrderedItem.class.ToType());

        // Reading the XML document requires a FileStream.
        Stream reader = new FileStream(fileName, FileMode.Open);

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

        // Call 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);
    } //DeserializeObject
} //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

Community Additions

ADD
Show:
© 2014 Microsoft