Namespace: System.Xml.Serialization
Assembly: System.Xml (in System.Xml.dll)
Public Sub Serialize ( _ stream As Stream, _ o As Object _ )
public void Serialize( Stream stream, Object o )
public: void Serialize( Stream^ stream, Object^ o )
member Serialize : stream:Stream * o:Object -> unit
Parameters
- stream
- Type: System.IO.Stream
The Stream used to write the XML document.
- o
- Type: System.Object
The Object to serialize.
| Exception | Condition |
|---|---|
| InvalidOperationException |
An error occurred during serialization. The original exception is available using the InnerException property. |
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 of an object's fields and properties, both public and private, use the BinaryFormatter.
In the stream parameter, specify an object that derives from the abstract Stream class. Classes that derive from Stream include:
Note
|
|---|
|
The XmlSerializer cannot serialize the following: arrays of ArrayList and arrays of List<T>. |
The following example serializes an object using a Stream object.
Imports System Imports System.IO 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 Stream") 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 FileStream to write with. Dim writer As New FileStream(filename, FileMode.Create) ' Serialize the object, and close the TextWriter serializer.Serialize(writer, i) writer.Close() End Sub End Class
using System; using System.IO; using System.Xml.Serialization; // This is the class that will be serialized. public class OrderedItem { public string ItemName; public string Description; public decimal UnitPrice; public int Quantity; 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(string[] args) { Test t = new Test(); // Write a purchase order. t.SerializeObject("simple.xml"); } private void SerializeObject(string filename) { Console.WriteLine("Writing With Stream"); XmlSerializer serializer = new XmlSerializer(typeof(OrderedItem)); OrderedItem i = new OrderedItem(); i.ItemName = "Widget"; i.Description = "Regular Widget"; i.Quantity = 10; i.UnitPrice = (decimal) 2.30; i.Calculate(); // Create a FileStream to write with. Stream writer = new FileStream(filename, FileMode.Create); // Serialize the object, and close the TextWriter serializer.Serialize(writer, i); writer.Close(); } }
#using <System.Xml.dll> #using <System.dll> using namespace System; using namespace System::IO; using namespace System::Xml::Serialization; // This is the class that will be serialized. 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 SerializeObject( String^ filename ) { Console::WriteLine( "Writing With Stream" ); XmlSerializer^ serializer = gcnew XmlSerializer( OrderedItem::typeid ); OrderedItem^ i = gcnew OrderedItem; i->ItemName = "Widget"; i->Description = "Regular Widget"; i->Quantity = 10; i->UnitPrice = (Decimal)2.30; i->Calculate(); // Create a FileStream to write with. Stream^ writer = gcnew FileStream( filename,FileMode::Create ); // Serialize the object, and close the TextWriter serializer->Serialize( writer, i ); writer->Close(); } int main() { // Write a purchase order. SerializeObject( "simple.xml" ); }
<?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, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryWindows 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.
Note