XmlObjectSerializer Class

Reference

Definition

Namespace:: System.Runtime.Serialization

Assembly:: System.Runtime.Serialization.Xml.dll

Assembly:: System.Runtime.Serialization.dll

Assembly:: netstandard.dll

Source:: XmlObjectSerializer.cs

Source:: XmlObjectSerializer.cs

Source:: XmlObjectSerializer.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides the base class used to serialize objects as XML streams or documents. This class is abstract.

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.

Constructors

XmlObjectSerializer()

Initializes a new instance of the XmlObjectSerializer class.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsStartObject(XmlDictionaryReader)	Gets a value that specifies whether the XmlDictionaryReader is positioned over an XML element that can be read.
IsStartObject(XmlReader)	Gets a value that specifies whether the XmlReader is positioned over an XML element that can be read.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ReadObject(Stream)	Reads the XML stream or document with a Stream and returns the deserialized object.
ReadObject(XmlDictionaryReader)	Reads the XML document or stream with an XmlDictionaryReader and returns the deserialized object.
ReadObject(XmlDictionaryReader, Boolean)	Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; it also enables you to specify whether the serializer can read the data before attempting to read it.
ReadObject(XmlReader)	Reads the XML document or stream with an XmlReader and returns the deserialized object.
ReadObject(XmlReader, Boolean)	Reads the XML document or stream with an XmlReader and returns the deserialized object; it also enables you to specify whether the serializer can read the data before attempting to read it.
ToString()	Returns a string that represents the current object. (Inherited from Object)
WriteEndObject(XmlDictionaryWriter)	Writes the end of the object data as a closing XML element to the XML document or stream with an XmlDictionaryWriter.
WriteEndObject(XmlWriter)	Writes the end of the object data as a closing XML element to the XML document or stream with an XmlWriter.
WriteObject(Stream, Object)	Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified Stream.
WriteObject(XmlDictionaryWriter, Object)	Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlDictionaryWriter.
WriteObject(XmlWriter, Object)	Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlWriter.
WriteObjectContent(XmlDictionaryWriter, Object)	Writes only the content of the object to the XML document or stream using the specified XmlDictionaryWriter.
WriteObjectContent(XmlWriter, Object)	Writes only the content of the object to the XML document or stream with the specified XmlWriter.
WriteStartObject(XmlDictionaryWriter, Object)	Writes the start of the object's data as an opening XML element using the specified XmlDictionaryWriter.
WriteStartObject(XmlWriter, Object)	Writes the start of the object's data as an opening XML element using the specified XmlWriter.

Applies to

Share via