XmlObjectSerializer Class

Definition

public ref class XmlObjectSerializer abstract

public abstract class XmlObjectSerializer

type XmlObjectSerializer = class

Public MustInherit Class XmlObjectSerializer

Inheritance

Object

XmlObjectSerializer

Derived

System.Runtime.Serialization.DataContractSerializer

System.Runtime.Serialization.Json.DataContractJsonSerializer

System.Runtime.Serialization.NetDataContractSerializer

Examples

The following example shows a method named WriteObjectWithInstance that includes an XmlObjectSerializer as a parameter. The method serializes an object using either the DataContractSerializer or NetDataContractSerializer by calling the WriteObject method.

public class Test
{
 private void WriteObjectWithInstance(XmlObjectSerializer xm, Company graph,
 string fileName)
 {
 // Use either the XmlDataContractSerializer or NetDataContractSerializer,
 // or any other class that inherits from XmlObjectSerializer to write with.
 Console.WriteLine(xm.GetType());
 FileStream fs = new FileStream(fileName, FileMode.Create);
 XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
 xm.WriteObject(writer, graph);
 Console.WriteLine("Done writing {0}", fileName);
 }

 private void Run()
 {
 // Create the object to write to a file.
 Company graph = new Company();
 graph.Name = "cohowinery.com";

 // Create a DataContractSerializer and a NetDataContractSerializer.
 // Pass either one to the WriteObjectWithInstance method.
 DataContractSerializer dcs = new DataContractSerializer(typeof(Company));
 NetDataContractSerializer ndcs = new NetDataContractSerializer();
 WriteObjectWithInstance(dcs, graph, @"datacontract.xml");
 WriteObjectWithInstance(ndcs, graph, @"netDatacontract.xml");
 }

 [DataContract]
 public class Company
 {
 [DataMember]
 public string Name;
 }

 static void Main()
 {
 try
 {
 Console.WriteLine("Starting");
 Test t = new Test();
 t.Run();
 Console.WriteLine("Done");
 Console.ReadLine();
 }

 catch (InvalidDataContractException iExc)
 {
 Console.WriteLine("You have an invalid data contract: ");
 Console.WriteLine(iExc.Message);
 Console.ReadLine();
 }

 catch (SerializationException serExc)
 {
 Console.WriteLine("There is a problem with the instance:");
 Console.WriteLine(serExc.Message);
 Console.ReadLine();
 }

 catch (QuotaExceededException qExc)
 {
 Console.WriteLine("The quota has been exceeded");
 Console.WriteLine(qExc.Message);
 Console.ReadLine();
 }
 catch (Exception exc)
 {
 Console.WriteLine(exc.Message);
 Console.WriteLine(exc.ToString());
 Console.ReadLine();
 }
 }

Public Class Test
 
 Private Sub WriteObjectWithInstance(ByVal xm As XmlObjectSerializer, _
 ByVal graph As Company, ByVal fileName As String) 
 ' Use either the XmlDataContractSerializer or NetDataContractSerializer,
 ' or any other class that inherits from XmlObjectSerializer to write with.
 Console.WriteLine(xm.GetType())
 Dim fs As New FileStream(fileName, FileMode.Create)
 Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
 xm.WriteObject(writer, graph)
 Console.WriteLine("Done writing {0}", fileName)
 
 End Sub 
 
 
 Private Sub Run() 
 ' Create the object to write to a file.
 Dim graph As New Company()
 graph.Name = "cohowinery.com"
 
 ' Create a DataContractSerializer and a NetDataContractSerializer.
 ' Pass either one to the WriteObjectWithInstance method.
 Dim dcs As New DataContractSerializer(GetType(Company))
 Dim ndcs As New NetDataContractSerializer()
 WriteObjectWithInstance(dcs, graph, "datacontract.xml")
 WriteObjectWithInstance(ndcs, graph, "netDatacontract.xml")
 
 End Sub 
 
 <DataContract()> _
 Public Class Company
 <DataMember()> _
 Public Name As String
 End Class 
 
 
 Shared Sub Main() 
 Try
 Console.WriteLine("Starting")
 Dim t As New Test()
 t.Run()
 Console.WriteLine("Done")
 Console.ReadLine()
 
 Catch iExc As InvalidDataContractException
 Console.WriteLine("You have an invalid data contract: ")
 Console.WriteLine(iExc.Message)
 Console.ReadLine()
 
 Catch serExc As SerializationException
 Console.WriteLine("There is a problem with the instance:")
 Console.WriteLine(serExc.Message)
 Console.ReadLine()
 
 Catch qExc As QuotaExceededException
 Console.WriteLine("The quota has been exceeded")
 Console.WriteLine(qExc.Message)
 Console.ReadLine()
 Catch exc As Exception
 Console.WriteLine(exc.Message)
 Console.WriteLine(exc.ToString())
 Console.ReadLine()
 End Try
 
 End Sub 
End Class

Remarks

Extend the XmlObjectSerializer to create your own serializer to serialize and deserialize objects. Both the DataContractSerializer class and the NetDataContractSerializer class inherit from the XmlObjectSerializer and are used to serialize and deserialize objects that conform to data contract rules (objects created using the DataContractAttribute and the DataMemberAttribute).

Notes to Implementers

When you inherit from XmlObjectSerializer, you must override the following members: WriteStartObject(XmlDictionaryWriter, Object), WriteObjectContent(XmlDictionaryWriter, Object), WriteEndObject(XmlDictionaryWriter). Additionally, the IsStartObject and ReadObject methods must be implemented for reading and deserializing.

See also

• DataContractSerializer
• NetDataContractSerializer
• Using Data Contracts
• Data Contract Serializer