NetDataContractSerializer Clase

Referencia

Definición

Espacio de nombres:: System.Runtime.Serialization

Ensamblado:: System.Runtime.Serialization.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Serializa y deserializa una instancia de un tipo en secuencia XML o en documento utilizando los tipos de .NET Framework proporcionados. Esta clase no puede heredarse.

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

Herencia: Object

XmlObjectSerializer
NetDataContractSerializer

Implementaciones: IFormatter

Ejemplos

El código de ejemplo siguiente muestra un tipo denominado Person que es serializado por NetDataContractSerializer. El atributo DataContractAttribute se aplica a la clase y DataMemberAttribute se aplica a los miembros (incluso a un miembro privado) para indicar a NetDataContractSerializer qué debe serializar.

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

Comentarios

Seguridad

NetDataContractSerializer no es seguro. Para obtener más información, vea Guía de seguridad de BinaryFormatter.

NetDataContractSerializer difiere de DataContractSerializer en un aspecto importante: NetDataContractSerializer incluye información de tipo CLR en el XML serializado, mientras que DataContractSerializer no lo hace. Por lo tanto, sólo se puede utilizar NetDataContractSerializer si los fines de serialización y de deserialización comparten los mismos tipos CLR.

El serializador puede serializar los tipos a los que no se ha aplicado el atributo DataContractAttribute o SerializableAttribute. También serializa tipos que implementan ISerializable.

Para obtener más información sobre la serialización, consulte Serialización y deserialización.

Incompatibilidad con XElement

La clase XElement se utiliza para escribir XML. Sin embargo, NetDataContractSerializer no puede serializar ninguna instancia de ese tipo. Por lo tanto, se produce un error en el código siguiente con la excepción : "Tipo raíz "System.Xml. NetDataContractSerializer no admite Linq.XElement' en el nivel superior, ya que es IXmlSerializable con IsAny=true y debe escribir todo su contenido, incluido el elemento raíz".

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)

Sin embargo, si XElement se utiliza como tipo de un campo o propiedad de una clase, se serializan los datos que contiene el campo o la propiedad. Esto sucede porque los datos, como miembro de una clase, no son el nivel superior de la clase.

Constructores

NetDataContractSerializer()	Inicializa una nueva instancia de la clase NetDataContractSerializer.
NetDataContractSerializer(StreamingContext)	Inicializa una instancia nueva de la clase NetDataContractSerializer con los datos de contexto de transmisión por secuencias proporcionados.
NetDataContractSerializer(StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)	Inicializa una nueva instancia de la clase NetDataContractSerializer con los datos de contexto proporcionados; además, especifica el número máximo de elementos en el objeto que se va a serializar y los parámetros para especificar si se omiten los datos adicionales, el método de carga de ensamblado y un selector de suplentes.
NetDataContractSerializer(String, String)	Inicializa una instancia nueva de la clase NetDataContractSerializer con el elemento raíz y el espacio de nombres de XML proporcionados.
NetDataContractSerializer(String, String, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)	Inicializa una nueva instancia de la clase NetDataContractSerializer con los datos de contexto proporcionados y el nombre y espacio de nombres raíz; además, especifica el número máximo de elementos en el objeto que se va a serializar y los parámetros para especificar si se omiten los datos adicionales, el método de carga de ensamblado y un selector de suplentes.
NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString)	Inicializa una instancia nueva de la clase NetDataContractSerializer con dos parámetros de tipo XmlDictionaryString que contienen el elemento raíz y el espacio de nombres utilizados para especificar el contenido.
NetDataContractSerializer(XmlDictionaryString, XmlDictionaryString, StreamingContext, Int32, Boolean, FormatterAssemblyStyle, ISurrogateSelector)	Inicializa una nueva instancia de la clase NetDataContractSerializer con los datos de contexto proporcionados y el nombre y espacio de nombres raíz (como parámetros XmlDictionaryString); además, especifica el número máximo de elementos en el objeto que se va a serializar y los parámetros para especificar si se omiten los datos adicionales encontrados, el método de carga de ensamblado y un selector de suplentes.

Propiedades

AssemblyFormat	Obtiene un valor que especifica un método para buscar y cargar los ensamblados.
Binder	Obtiene o establece un objeto que controla la carga de clase.
Context	Obtiene o establece el objeto que permite el paso de datos de contexto, que es útil mientras se serializa o se deserializa.
IgnoreExtensionDataObject	Obtiene un valor que especifica si se omiten los datos proporcionados por una extensión del objeto.
MaxItemsInObjectGraph	Obtiene el número máximo de elementos permitido en el objeto que se va a serializar.
SurrogateSelector	Obtiene o establece un objeto que ayuda al formateador al seleccionar un suplente para la serialización.

Métodos

Deserialize(Stream)	Deserializa un documento o secuencia XML en un objeto.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsStartObject(XmlDictionaryReader)	Determina si XmlDictionaryReader se coloca sobre un objeto que se puede deserializar utilizando el lector especificado.
IsStartObject(XmlReader)	Determina si XmlReader se coloca sobre un objeto que se puede deserializar utilizando el lector especificado.
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ReadObject(Stream)	Lee la secuencia o el documento XML con Stream y devuelve el objeto deserializado. (Heredado de XmlObjectSerializer)
ReadObject(XmlDictionaryReader)	Lee el documento o la secuencia XML con XmlDictionaryReader y devuelve el objeto deserializado. (Heredado de XmlObjectSerializer)
ReadObject(XmlDictionaryReader, Boolean)	Lee la secuencia o el documento XML con XmlDictionaryReader y devuelve el objeto deserializado; también comprueba si los datos del objeto se ajustan al nombre y al espacio de nombres utilizados para crear el serializador.
ReadObject(XmlReader)	Lee la secuencia o el documento XML con XmlDictionaryReader y devuelve el objeto deserializado.
ReadObject(XmlReader, Boolean)	Lee la secuencia o el documento XML con XmlDictionaryReader y devuelve el objeto deserializado; también comprueba si los datos del objeto se ajustan al nombre y al espacio de nombres utilizados para crear el serializador.
Serialize(Stream, Object)	Serializa el gráfico de objetos especificado mediante el sistema de escritura especificado.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
WriteEndObject(XmlDictionaryWriter)	Escribe el elemento XML de cierre mediante XmlDictionaryWriter.
WriteEndObject(XmlWriter)	Escribe el elemento XML de cierre mediante XmlWriter.
WriteObject(Stream, Object)	Escribe todo el contenido (inicio, contenido y fin) del objeto en el documento o la secuencia XML con el Stream especificado. (Heredado de XmlObjectSerializer)
WriteObject(XmlDictionaryWriter, Object)	Escribe todo el contenido (inicio, contenido y fin) del objeto en el documento o la secuencia XML con el XmlDictionaryWriter especificado. (Heredado de XmlObjectSerializer)
WriteObject(XmlWriter, Object)	Escribe todo el contenido (inicio, contenido y fin) del objeto en el documento o la secuencia XML con el XmlWriter especificado.
WriteObjectContent(XmlDictionaryWriter, Object)	Escribe el contenido XML mediante XmlDictionaryWriter.
WriteObjectContent(XmlWriter, Object)	Escribe el contenido XML mediante XmlWriter.
WriteStartObject(XmlDictionaryWriter, Object)	Escribe el elemento XML de apertura mediante XmlDictionaryWriter.
WriteStartObject(XmlWriter, Object)	Escribe el elemento XML de apertura mediante XmlWriter.

Se aplica a

Produto	Versións
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Compartir por