NetDataContractSerializer Klasse

Definition

Serialisiert oder deserialisiert mithilfe der bereitgestellten .NET Framework-Typen eine Instanz eines Typs in einen XML-Stream oder ein XML-Dokument.Serializes and deserializes an instance of a type into XML stream or document using the supplied .NET Framework types. Diese Klasse kann nicht vererbt werden.This class cannot be inherited.

public ref class NetDataContractSerializer sealed : System::Runtime::Serialization::XmlObjectSerializer, System::Runtime::Serialization::IFormatter
public sealed class NetDataContractSerializer : System.Runtime.Serialization.XmlObjectSerializer, System.Runtime.Serialization.IFormatter
type NetDataContractSerializer = class
    inherit XmlObjectSerializer
    interface IFormatter
Public NotInheritable Class NetDataContractSerializer
Inherits XmlObjectSerializer
Implements IFormatter
Vererbung
NetDataContractSerializer
Implementiert

Beispiele

Der folgende Beispielcode zeigt einen Typen mit dem Namen Person, der vom NetDataContractSerializer serialisiert wird.The following example code shows a type named Person that is serialized by the NetDataContractSerializer. Das DataContractAttribute-Attribut wird auf die Klasse angewendet, und auf die Member (einschließlich eines privaten Members) wird DataMemberAttribute angewendet, um den NetDataContractSerializer anzuweisen, was serialisiert werden soll.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));
    }
}
' 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
    Implements IExtensibleDataObject
    <DataMember()>  _
    Public FirstName As String
    <DataMember()>  _
    Public LastName As String
    <DataMember()>  _
    Public ID As Integer
    
    
    Public Sub New(ByVal newfName As String, ByVal newLName As String, _
       ByVal newID As Integer) 
        FirstName = newfName
        LastName = newLName
        ID = newID
    
    End Sub 
    
    Private extensionData_Value As ExtensionDataObject
    
    
    Public Property ExtensionData() As ExtensionDataObject _
     Implements IExtensibleDataObject.ExtensionData
        Get
            Return extensionData_Value
        End Get
        Set
            extensionData_Value = value
        End Set
    End Property
End Class 


NotInheritable Public Class Test

    Private Sub New() 
    
    End Sub
     
    Public Shared Sub Main() 
        Try
            WriteObject("NetDataContractSerializerExample.xml")
            ReadObject("NetDataContractSerializerExample.xml")
        
        Catch serExc As SerializationException
            Console.WriteLine("Serialization Failed")
            Console.WriteLine(serExc.Message)
        Catch exc As Exception
            Console.WriteLine("The serialization operation failed: {0} StackTrace: {1}", exc.Message, exc.StackTrace)
        
        Finally
            Console.WriteLine("Press <Enter> to exit....")
            Console.ReadLine()
        End Try
    
    End Sub 
    
    
    Public Shared Sub WriteObject(ByVal fileName As String) 
        Console.WriteLine("Creating a Person object and serializing it.")
        Dim p1 As New Person("Zighetti", "Barbara", 101)
        Dim fs As New FileStream(fileName, FileMode.Create)
        Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()

        ser.WriteObject(writer, p1)
        writer.Close()
    
    End Sub     

    Public Shared Sub ReadObject(ByVal fileName As String) 
        Console.WriteLine("Deserializing an instance of the object.")
        Dim fs As New FileStream(fileName, FileMode.Open)
        Dim reader As XmlDictionaryReader = _
           XmlDictionaryReader.CreateTextReader(fs, New XmlDictionaryReaderQuotas())
        Dim ser As New System.Runtime.Serialization.NetDataContractSerializer()
        
        ' Deserialize the data and read it from the instance.
        Dim deserializedPerson As Person = CType(ser.ReadObject(reader, True), Person)
        fs.Close()
        Console.WriteLine(String.Format("{0} {1}, ID: {2}", deserializedPerson.FirstName, deserializedPerson.LastName, deserializedPerson.ID))
    
    End Sub 
End Class 

Hinweise

Der NetDataContractSerializer unterscheidet sich vom DataContractSerializer in einem wichtigen Punkt: Der NetDataContractSerializer enthält im Gegensatz zum DataContractSerializer CLR-Typinformationen im serialisierten XML.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. Der NetDataContractSerializer kann daher nur verwendet werden, wenn sowohl der Endpunkt für die Serialisierung als auch der Endpunkt für die Deserialisierung den gleichen CLR-Typ aufweisen.Therefore, the NetDataContractSerializer can be used only if both the serializing and deserializing ends share the same CLR types.

Das Serialisierungsprogramm kann Typen serialisieren, auf die das DataContractAttribute- oder das SerializableAttribute-Attribut angewendet wurde.The serializer can serialize types to which either the DataContractAttribute or SerializableAttribute attribute has been applied. Weiterhin serialisiert es Typen, die ISerializable implementieren.It also serializes types that implement ISerializable.

Weitere Informationen zur Serialisierung finden Sie unter Serialisierung und Deserialisierung.For more information about serialization, see Serialization and Deserialization.

Inkompatibilität mit XElementIncompatibility with XElement

Die XElement-Klasse wird zum Schreiben von XML verwendet.The XElement class is used to write XML. Der NetDataContractSerializer kann jedoch keine Instanz des Typs serialisieren.However, the NetDataContractSerializer cannot serialize an instance of the type. Der folgende Code schlägt daher mit der Ausnahme fehl: "Der Stammtyp ' System. Xml. Linq. XElement ' wird auf der obersten Ebene von NetDataContractSerializer nicht unterstützt, da er ixmlserialisierbar IsAny = true ist und den gesamten Inhalt einschließlich des Stamm Elements schreiben muss."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);
Dim fs As New FileStream("mystuff.xml", FileMode.Create, FileAccess.ReadWrite)
Dim myElement As New XElement("Parent", New XElement("child1", "form"), _
    New XElement("child2", "base"), _
    New XElement("child3", "formbase") _
    )
Dim ser As New System.Runtime.Serialization. _
  NetDataContractSerializer()
ser.WriteObject(fs, myElement)

Wenn ein XElement jedoch als Typ eines Felds oder Eigenschaft einer Klasse verwendet wird, werden die in dem Feld bzw. der Eigenschaft enthaltenen Daten serialisiert.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. Dies ist darauf zurückzuführen, dass die Daten sich als Member einer Klasse nicht auf der übergeordneten Ebene der Klasse befinden.This is because as a member of a class, the data is not the top level of the class.

Konstruktoren

NetDataContractSerializer()

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse.Initializes a new instance of the NetDataContractSerializer class.

NetDataContractSerializer(StreamingContext)

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit den bereitgestellten Streamingkontextdaten.Initializes a new instance of the NetDataContractSerializer class with the supplied streaming context data.

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

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit den angegebenen Kontextdaten. Weiterhin werden die maximal zu serialisierende Anzahl von Elementen in dem Objekt, Parameter zum Festlegen, ob zusätzliche Daten ignoriert werden, die Methoden zum Laden einer Assembly und ein Ersatzselektor angegeben.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.

NetDataContractSerializer(String, String)

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit dem angegebenen XML-Stammelement und Namespace.Initializes a new instance of the NetDataContractSerializer class with the supplied XML root element and namespace.

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

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit den angegebenen Kontextdaten, dem Stammnamen und dem Namespace. Weiterhin werden die maximal zu serialisierende Anzahl von Elementen in dem Objekt, Parameter zum Festlegen, ob zusätzliche Daten ignoriert werden, die Methoden zum Laden einer Assembly und ein Ersatzselektor angegeben.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.

NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit zwei Parametern vom Typ XmlDictionaryString, die das Stammelement und den Namespace enthalten, die zum Angeben des Inhalts verwendet werden.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.

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

Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit den angegebenen Kontextdaten, dem Stammnamen und dem Namespace (als XmlDictionaryString-Parameter). Weiterhin werden die maximal zu serialisierende Anzahl von Elementen in dem Objekt, Parameter zum Festlegen, ob zusätzliche Daten ignoriert werden, die Methoden zum Laden einer Assembly und ein Ersatzselektor angegeben.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.

Eigenschaften

AssemblyFormat

Ruft einen Wert ab, der eine Methode zum Suchen und Laden von Assemblys angibt.Gets a value that specifies a method for locating and loading assemblies.

Binder

Ruft ein Objekt ab bzw. legt ein Objekt fest, das das Laden von Klassen steuert.Gets or sets an object that controls class loading.

Context

Ruft das Objekt ab bzw. legt das Objekt fest, das das Übergeben von Kontextdaten ermöglicht, die bei der Serialisierung oder Deserialisierung hilfreich sind.Gets or sets the object that enables the passing of context data that is useful while serializing or deserializing.

IgnoreExtensionDataObject

Ruft einen Wert ab, der angibt, ob die von einer Erweiterung des Objekts angegebenen Daten ignoriert werden.Gets a value that specifies whether data supplied by an extension of the object is ignored.

MaxItemsInObjectGraph

Ruft die maximale Anzahl von Elementen ab, die in dem zu serialisierenden Objekt zulässig ist.Gets the maximum number of items allowed in the object to be serialized.

SurrogateSelector

Ruft ein Objekt ab bzw. legt ein Objekt fest, das das Formatierungsprogramm beim Auswählen eines Ersatzzeichens für die Serialisierung unterstützt.Gets or sets an object that assists the formatter when selecting a surrogate for serialization.

Methoden

Deserialize(Stream)

Deserialisiert ein XML-Dokument oder einen XML-Stream in ein Objekt.Deserializes an XML document or stream into an object.

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsStartObject(XmlDictionaryReader)

Bestimmt, ob der XmlDictionaryReader auf einem Objekt positioniert ist, das mit dem angegebenen Reader deserialisiert werden kann.Determines whether the XmlDictionaryReader is positioned on an object that can be deserialized using the specified reader.

IsStartObject(XmlReader)

Bestimmt, ob der XmlReader auf einem Objekt positioniert ist, das mit dem angegebenen Reader deserialisiert werden kann.Determines whether the XmlReader is positioned on an object that can be deserialized using the specified reader.

MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ReadObject(Stream)

Liest den XML-Stream oder das XML-Dokument mit einem Stream und gibt das deserialisierte Objekt zurück.Reads the XML stream or document with a Stream and returns the deserialized object.

(Geerbt von XmlObjectSerializer)
ReadObject(XmlDictionaryReader)

Liest das XML-Dokument oder den XML-Stream mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück.Reads the XML document or stream with an XmlDictionaryReader and returns the deserialized object.

(Geerbt von XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)

Liest den XML-Stream oder das XML-Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. Weiterhin wird überprüft, ob die Objektdaten mit dem Namen und Namespace übereinstimmen, die zum Erstellen des Serialisierungsprogramms verwendet wurden.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.

ReadObject(XmlReader)

Liest den XML-Stream oder das XML-Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück.Reads the XML stream or document with an XmlDictionaryReader and returns the deserialized object.

ReadObject(XmlReader, Boolean)

Liest den XML-Stream oder das XML-Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. Weiterhin wird überprüft, ob die Objektdaten mit dem Namen und Namespace übereinstimmen, die zum Erstellen des Serialisierungsprogramms verwendet wurden.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.

Serialize(Stream, Object)

Serialisiert das angegebene Objektdiagramm mit dem genannten Writer.Serializes the specified object graph using the specified writer.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)
WriteEndObject(XmlDictionaryWriter)

Schreibt das abschließende XML-Element mit einem XmlDictionaryWriter.Writes the closing XML element using an XmlDictionaryWriter.

WriteEndObject(XmlWriter)

Schreibt das abschließende XML-Element mit einem XmlWriter.Writes the closing XML element using an XmlWriter.

WriteObject(Stream, Object)

Schreibt den vollständigen Inhalt (Anfang, Inhalt und Ende) des Objekts in das XML-Dokument oder den XML-Stream mit dem angegebenen Stream.Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified Stream.

(Geerbt von XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)

Schreibt den vollständigen Inhalt (Anfang, Inhalt und Ende) des Objekts in das XML-Dokument oder den XML-Stream mit dem angegebenen XmlDictionaryWriter.Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlDictionaryWriter.

(Geerbt von XmlObjectSerializer)
WriteObject(XmlWriter, Object)

Schreibt den vollständigen Inhalt (Anfang, Inhalt und Ende) des Objekts in das XML-Dokument oder den XML-Stream mit dem angegebenen XmlWriter.Writes the complete content (start, content, and end) of the object to the XML document or stream with the specified XmlWriter.

WriteObjectContent(XmlDictionaryWriter, Object)

Schreibt den XML-Inhalt mit einem XmlDictionaryWriter.Writes the XML content using an XmlDictionaryWriter.

WriteObjectContent(XmlWriter, Object)

Schreibt den XML-Inhalt mit einem XmlWriter.Writes the XML content using an XmlWriter.

WriteStartObject(XmlDictionaryWriter, Object)

Schreibt das öffnende XML-Element mit einem XmlDictionaryWriter.Writes the opening XML element using an XmlDictionaryWriter.

WriteStartObject(XmlWriter, Object)

Schreibt das öffnende XML-Element mit einem XmlWriter.Writes the opening XML element using an XmlWriter.

Gilt für:

Siehe auch