NetDataContractSerializer Class

 

Serializes and deserializes an instance of a type into XML stream or document using the supplied .NET Framework types. This class cannot be inherited.

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

System.Object
  System.Runtime.Serialization.XmlObjectSerializer
    System.Runtime.Serialization.NetDataContractSerializer

public sealed class NetDataContractSerializer : XmlObjectSerializer, 
	IFormatter

NameDescription
System_CAPS_pubmethodNetDataContractSerializer()

Initializes a new instance of the NetDataContractSerializer class.

System_CAPS_pubmethodNetDataContractSerializer(StreamingContext)

Initializes a new instance of the NetDataContractSerializer class with the supplied streaming context data.

System_CAPS_pubmethodNetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

Initializes a new instance of the NetDataContractSerializer class with the supplied context data; in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data is ignored, the assembly loading method, and a surrogate selector.

System_CAPS_pubmethodNetDataContractSerializer(String, String)

Initializes a new instance of the NetDataContractSerializer class with the supplied XML root element and namespace.

System_CAPS_pubmethodNetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

Initializes a new instance of the NetDataContractSerializer class with the supplied context data and root name and namespace; in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data is ignored, the assembly loading method, and a surrogate selector.

System_CAPS_pubmethodNetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

Initializes a new instance of the NetDataContractSerializer class with two parameters of type XmlDictionaryString that contain the root element and namespace used to specify the content.

System_CAPS_pubmethodNetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)

Initializes a new instance of the NetDataContractSerializer class with the supplied context data, and root name and namespace (as XmlDictionaryString parameters); in addition, specifies the maximum number of items in the object to be serialized, and parameters to specify whether extra data found is ignored, assembly loading method, and a surrogate selector.

NameDescription
System_CAPS_pubpropertyAssemblyFormat

Gets a value that specifies a method for locating and loading assemblies.

System_CAPS_pubpropertyBinder

Gets or sets an object that controls class loading.

System_CAPS_pubpropertyContext

Gets or sets the object that enables the passing of context data that is useful while serializing or deserializing.

System_CAPS_pubpropertyIgnoreExtensionDataObject

Gets a value that specifies whether data supplied by an extension of the object is ignored.

System_CAPS_pubpropertyMaxItemsInObjectGraph

Gets the maximum number of items allowed in the object to be serialized.

System_CAPS_pubpropertySurrogateSelector

Gets or sets an object that assists the formatter when selecting a surrogate for serialization.

NameDescription
System_CAPS_pubmethodDeserialize(Stream)

Deserializes an XML document or stream into an object.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(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)

Determines whether the XmlDictionaryReader is positioned on an object that can be deserialized using the specified reader.(Overrides XmlObjectSerializer.IsStartObject(XmlDictionaryReader).)

System_CAPS_pubmethodIsStartObject(XmlReader)

Determines whether the XmlReader is positioned on an object that can be deserialized using the specified reader.(Overrides XmlObjectSerializer.IsStartObject(XmlReader).)

System_CAPS_pubmethodReadObject(Stream)

Reads the XML stream or document with a Stream and returns the deserialized object.(Inherited from XmlObjectSerializer.)

System_CAPS_pubmethodReadObject(XmlDictionaryReader)

Reads the XML document or stream with an XmlDictionaryReader and returns the deserialized object.(Inherited from XmlObjectSerializer.)

System_CAPS_pubmethodReadObject(XmlDictionaryReader, Boolean)

Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; also checks whether the object data conforms to the name and namespace used to create the serializer.(Overrides XmlObjectSerializer.ReadObject(XmlDictionaryReader, Boolean).)

System_CAPS_pubmethodReadObject(XmlReader)

Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object.(Overrides XmlObjectSerializer.ReadObject(XmlReader).)

System_CAPS_pubmethodReadObject(XmlReader, Boolean)

Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object; also checks whether the object data conforms to the name and namespace used to create the serializer.(Overrides XmlObjectSerializer.ReadObject(XmlReader, Boolean).)

System_CAPS_pubmethodSerialize(Stream, Object)

Serializes the specified object graph using the specified writer.

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodWriteEndObject(XmlDictionaryWriter)

Writes the closing XML element using an XmlDictionaryWriter.(Overrides XmlObjectSerializer.WriteEndObject(XmlDictionaryWriter).)

System_CAPS_pubmethodWriteEndObject(XmlWriter)

Writes the closing XML element using an XmlWriter.(Overrides XmlObjectSerializer.WriteEndObject(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.(Inherited from XmlObjectSerializer.)

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.(Inherited from XmlObjectSerializer.)

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.(Overrides XmlObjectSerializer.WriteObject(XmlWriter, Object).)

System_CAPS_pubmethodWriteObjectContent(XmlDictionaryWriter, Object)
System_CAPS_pubmethodWriteObjectContent(XmlWriter, Object)

Writes the XML content using an XmlWriter.(Overrides XmlObjectSerializer.WriteObjectContent(XmlWriter, Object).)

System_CAPS_pubmethodWriteStartObject(XmlDictionaryWriter, Object)
System_CAPS_pubmethodWriteStartObject(XmlWriter, Object)

Writes the opening XML element using an XmlWriter.(Overrides XmlObjectSerializer.WriteStartObject(XmlWriter, Object).)

The NetDataContractSerializer differs from the DataContractSerializer in one important way: the NetDataContractSerializer includes CLR type information in the serialized XML, whereas the DataContractSerializer does not. Therefore, the NetDataContractSerializer can be used only if both the serializing and deserializing ends share the same CLR types.

The serializer can serialize types to which either the DataContractAttribute or SerializableAttribute attribute has been applied. It also serializes types that implement ISerializable.

For more information about serialization, see Serialization and Deserialization.

The XElement class is used to write XML. However, the NetDataContractSerializer cannot serialize an instance of the type. The following code, therefore, fails with the exception: "Root type 'System.Xml.Linq.XElement' is not supported at the top level by NetDataContractSerializer since it is IXmlSerializable with IsAny=true and must write all its contents including the root element."

FileStream fs = new FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite);
XElement myElement = new XElement("Parent", new XElement("child1", "form"),
    new XElement("child2", "base"),
    new XElement("child3", "formbase")
    );
NetDataContractSerializer dcs = new NetDataContractSerializer();
dcs.WriteObject(fs, myElement);

However, if an XElement is used as the type of a field or property of a class, the data contained by the field or property is serialized. This is because as a member of a class, the data is not the top level of the class.

The following example code shows a type named Person that is serialized by the NetDataContractSerializer. The DataContractAttribute attribute is applied to the class, and the DataMemberAttribute is applied to members (including a private member) to instruct the NetDataContractSerializer what to serialize.

// You must apply a DataContractAttribute or SerializableAttribute
// to a class to have it serialized by the NetDataContractSerializer.
[DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
class Person : IExtensibleDataObject
{
    [DataMember()]
    public string FirstName;
    [DataMember]
    public string LastName;
    [DataMember()]
    public int ID;

    public Person(string newfName, string newLName, int newID)
    {
        FirstName = newfName;
        LastName = newLName;
        ID = newID;
    }

    private ExtensionDataObject extensionData_Value;

    public ExtensionDataObject ExtensionData
    {
        get
        {
            return extensionData_Value;
        }
        set
        {
            extensionData_Value = value;
        }
    }
}

public sealed class Test
{
    private Test() { }

    public static void Main()
    {
        try
        {
            WriteObject("NetDataContractSerializerExample.xml");
            ReadObject("NetDataContractSerializerExample.xml");
        }

        catch (SerializationException serExc)
        {
            Console.WriteLine("Serialization Failed");
            Console.WriteLine(serExc.Message);
        }
        catch (Exception exc)
        {
            Console.WriteLine(
            "The serialization operation failed: {0} StackTrace: {1}",
            exc.Message, exc.StackTrace);
        }

        finally
        {
            Console.WriteLine("Press <Enter> to exit....");
            Console.ReadLine();
        }
    }

    public static void WriteObject(string fileName)
    {
        Console.WriteLine(
            "Creating a Person object and serializing it.");
        Person p1 = new Person("Zighetti", "Barbara", 101);
        FileStream fs = new FileStream(fileName, FileMode.Create);
        XmlDictionaryWriter writer = XmlDictionaryWriter.CreateTextWriter(fs);
        NetDataContractSerializer ser =
            new NetDataContractSerializer();
        ser.WriteObject(writer, p1);
        writer.Close();
    }

    public static void ReadObject(string fileName)
    {
        Console.WriteLine("Deserializing an instance of the object.");
        FileStream fs = new FileStream(fileName,
        FileMode.Open);
        XmlDictionaryReader reader =
            XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
        NetDataContractSerializer ser = new NetDataContractSerializer();

        // Deserialize the data and read it from the instance.
        Person deserializedPerson =
            (Person)ser.ReadObject(reader, true);
        fs.Close();
        Console.WriteLine(String.Format("{0} {1}, ID: {2}",
        deserializedPerson.FirstName, deserializedPerson.LastName,
        deserializedPerson.ID));
    }
}

.NET Framework
Available since 3.0

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: