NetDataContractSerializer Klasse

Referenz

Definition

Namespace:: System.Runtime.Serialization

Assembly:: System.Runtime.Serialization.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Serialisiert oder deserialisiert mithilfe der bereitgestellten .NET Framework-Typen eine Instanz eines Typs in einen XML-Stream oder ein XML-Dokument. Diese Klasse kann nicht vererbt werden.

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

XmlObjectSerializer
NetDataContractSerializer

Implementiert: IFormatter

Beispiele

Der folgende Beispielcode zeigt einen Typen mit dem Namen Person, der vom NetDataContractSerializer serialisiert wird. 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.

// 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

Sicherheit

NetDataContractSerializer ist unsicher. Weitere Informationen finden Sie im Sicherheitsleitfaden für BinaryFormatter.

Der NetDataContractSerializer unterscheidet sich vom DataContractSerializer in einem wichtigen Punkt: Der NetDataContractSerializer enthält im Gegensatz zum DataContractSerializer CLR-Typinformationen im serialisierten XML. 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.

Das Serialisierungsprogramm kann Typen serialisieren, auf die das DataContractAttribute- oder das SerializableAttribute-Attribut angewendet wurde. Weiterhin serialisiert es Typen, die ISerializable implementieren.

Weitere Informationen zur Serialisierung finden Sie unter Serialisierung und Deserialisierung.

Inkompatibilität mit XElement

Die XElement-Klasse wird zum Schreiben von XML verwendet. Der NetDataContractSerializer kann jedoch keine Instanz des Typs serialisieren. Der folgende Code schlägt daher mit der Ausnahme fehl: "Stammtyp 'System.Xml. Linq.XElement' wird von NetDataContractSerializer nicht auf oberster Ebene unterstützt, da es IXmlSerializierbar IsAny=true ist und alle Inhalte einschließlich des Stammelements schreiben muss."

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. Dies ist darauf zurückzuführen, dass die Daten sich als Member einer Klasse nicht auf der übergeordneten Ebene der Klasse befinden.

Konstruktoren

NetDataContractSerializer()	Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse.
NetDataContractSerializer(StreamingContext)	Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit den bereitgestellten Streamingkontextdaten.
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.
NetDataContractSerializer(String, String)	Initialisiert eine neue Instanz der NetDataContractSerializer-Klasse mit dem angegebenen XML-Stammelement und 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.
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.
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.

Eigenschaften

AssemblyFormat	Ruft einen Wert ab, der eine Methode zum Suchen und Laden von Assemblys angibt.
Binder	Ruft ein Objekt ab bzw. legt ein Objekt fest, das das Laden von Klassen steuert.
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.
IgnoreExtensionDataObject	Ruft einen Wert ab, der angibt, ob die von einer Erweiterung des Objekts angegebenen Daten ignoriert werden.
MaxItemsInObjectGraph	Ruft die maximale Anzahl von Elementen ab, die in dem zu serialisierenden Objekt zulässig ist.
SurrogateSelector	Ruft ein Objekt ab bzw. legt ein Objekt fest, das das Formatierungsprogramm beim Auswählen eines Ersatzzeichens für die Serialisierung unterstützt.

Methoden

Deserialize(Stream)	Deserialisiert ein XML-Dokument oder einen XML-Stream in ein Objekt.
Equals(Object)	Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object)
GetHashCode()	Fungiert als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsStartObject(XmlDictionaryReader)	Bestimmt, ob der XmlDictionaryReader auf einem Objekt positioniert ist, das mit dem angegebenen Reader deserialisiert werden kann.
IsStartObject(XmlReader)	Bestimmt, ob der XmlReader auf einem Objekt positioniert ist, das mit dem angegebenen Reader deserialisiert werden kann.
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ReadObject(Stream)	Liest den XML-Stream oder das XML-Dokument mit einem Stream und gibt das deserialisierte Objekt zurück. (Geerbt von XmlObjectSerializer)
ReadObject(XmlDictionaryReader)	Liest das XML-Dokument oder den XML-Stream mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück. (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.
ReadObject(XmlReader)	Liest den XML-Stream oder das XML-Dokument mit einem XmlDictionaryReader und gibt das deserialisierte Objekt zurück.
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.
Serialize(Stream, Object)	Serialisiert das angegebene Objektdiagramm mit dem genannten Writer.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
WriteEndObject(XmlDictionaryWriter)	Schreibt das abschließende XML-Element mit einem XmlDictionaryWriter.
WriteEndObject(XmlWriter)	Schreibt das abschließende XML-Element mit einem 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. (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. (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.
WriteObjectContent(XmlDictionaryWriter, Object)	Schreibt den XML-Inhalt mit einem XmlDictionaryWriter.
WriteObjectContent(XmlWriter, Object)	Schreibt den XML-Inhalt mit einem XmlWriter.
WriteStartObject(XmlDictionaryWriter, Object)	Schreibt das öffnende XML-Element mit einem XmlDictionaryWriter.
WriteStartObject(XmlWriter, Object)	Schreibt das öffnende XML-Element mit einem XmlWriter.

Gilt für:

Teilen über