XmlObjectSerializer Class
TOC
Collapse the table of content
Expand the table of content

XmlObjectSerializer Class

 

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

Namespace:   System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)


public abstract class XmlObjectSerializer

NameDescription
System_CAPS_protmethodXmlObjectSerializer()

Initializes a new instance of the XmlObjectSerializer class.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsStartObject(XmlDictionaryReader)

Gets a value that specifies whether the XmlDictionaryReader is positioned over an XML element that can be read.

System_CAPS_pubmethodIsStartObject(XmlReader)

Gets a value that specifies whether the XmlReader is positioned over an XML element that can be read.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodReadObject(Stream)

Reads the XML stream or document with a Stream and returns the deserialized object.

System_CAPS_pubmethodReadObject(XmlDictionaryReader)

Reads the XML document or stream with an XmlDictionaryReader and returns the deserialized object.

System_CAPS_pubmethodReadObject(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.

System_CAPS_pubmethodReadObject(XmlReader)

Reads the XML document or stream with an XmlReader and returns the deserialized object.

System_CAPS_pubmethodReadObject(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.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWriteEndObject(XmlDictionaryWriter)

Writes the end of the object data as a closing XML element to the XML document or stream with an XmlDictionaryWriter.

System_CAPS_pubmethodWriteEndObject(XmlWriter)

Writes the end of the object data as a closing XML element to the XML document or stream with an XmlWriter.

System_CAPS_pubmethodWriteObject(Stream, Object)

Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified Stream.

System_CAPS_pubmethodWriteObject(XmlDictionaryWriter, Object)

Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteObject(XmlWriter, Object)

Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlWriter.

System_CAPS_pubmethodWriteObjectContent(XmlDictionaryWriter, Object)

Writes only the content of the object to the XML document or stream using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteObjectContent(XmlWriter, Object)

Writes only the content of the object to the XML document or stream with the specified XmlWriter.

System_CAPS_pubmethodWriteStartObject(XmlDictionaryWriter, Object)

Writes the start of the object's data as an opening XML element using the specified XmlDictionaryWriter.

System_CAPS_pubmethodWriteStartObject(XmlWriter, Object)

Writes the start of the object's data as an opening XML element using the specified XmlWriter.

Exception Condition
InvalidDataContractException

the type being serialized does not conform to data contract rules. For example, the DataContractAttribute attribute has not been applied to the type.

SerializationException

there is a problem with the instance being serialized.

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 Inheritors:

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

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();
        }
    }

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft