XmlObjectSerializer Clase

Referencia

Definición

Espacio de nombres:: System.Runtime.Serialization

Ensamblado:: System.Runtime.Serialization.Xml.dll

Ensamblado:: System.Runtime.Serialization.dll

Ensamblado:: netstandard.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í.

Proporciona la clase base usada para serializar objetos como secuencias XML o documentos. Esta clase es abstracta.

public ref class XmlObjectSerializer abstract

public abstract class XmlObjectSerializer

type XmlObjectSerializer = class

Public MustInherit Class XmlObjectSerializer

Herencia: Object
XmlObjectSerializer

Derivado: System.Runtime.Serialization.DataContractSerializer

System.Runtime.Serialization.Json.DataContractJsonSerializer

System.Runtime.Serialization.NetDataContractSerializer

Ejemplos

El ejemplo siguiente muestra un método denominado WriteObjectWithInstance que incluye un XmlObjectSerializer como parámetro. El método serializa un objeto con DataContractSerializer o NetDataContractSerializer llamando al método WriteObject.

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

Public Class Test
    
    Private Sub WriteObjectWithInstance(ByVal xm As XmlObjectSerializer, _
      ByVal graph As Company, ByVal fileName As String) 
        ' Use either the XmlDataContractSerializer or NetDataContractSerializer,
        ' or any other class that inherits from XmlObjectSerializer to write with.
        Console.WriteLine(xm.GetType())
        Dim fs As New FileStream(fileName, FileMode.Create)
        Dim writer As XmlDictionaryWriter = XmlDictionaryWriter.CreateTextWriter(fs)
        xm.WriteObject(writer, graph)
        Console.WriteLine("Done writing {0}", fileName)
    
    End Sub 
    
    
    Private Sub Run() 
        ' Create the object to write to a file.
        Dim graph As New Company()
        graph.Name = "cohowinery.com"
        
        ' Create a DataContractSerializer and a NetDataContractSerializer.
        ' Pass either one to the WriteObjectWithInstance method.
        Dim dcs As New DataContractSerializer(GetType(Company))
        Dim ndcs As New NetDataContractSerializer()
        WriteObjectWithInstance(dcs, graph, "datacontract.xml")
        WriteObjectWithInstance(ndcs, graph, "netDatacontract.xml")
    
    End Sub 
    
    <DataContract()>  _
    Public Class Company
        <DataMember()>  _
        Public Name As String
    End Class 
    
    
    Shared Sub Main() 
        Try
            Console.WriteLine("Starting")
            Dim t As New Test()
            t.Run()
            Console.WriteLine("Done")
            Console.ReadLine()
        
        Catch iExc As InvalidDataContractException
            Console.WriteLine("You have an invalid data contract: ")
            Console.WriteLine(iExc.Message)
            Console.ReadLine()
        
        Catch serExc As SerializationException
            Console.WriteLine("There is a problem with the instance:")
            Console.WriteLine(serExc.Message)
            Console.ReadLine()
        
        Catch qExc As QuotaExceededException
            Console.WriteLine("The quota has been exceeded")
            Console.WriteLine(qExc.Message)
            Console.ReadLine()
        Catch exc As Exception
            Console.WriteLine(exc.Message)
            Console.WriteLine(exc.ToString())
            Console.ReadLine()
        End Try
    
    End Sub 
End Class

Comentarios

Extienda XmlObjectSerializer para crear su propio serializador a fin de serializar y deserializar objetos. La clase DataContractSerializer y la clase NetDataContractSerializer se heredan de XmlObjectSerializer y se usan para serializar y deserializar objetos que se ajustan a las reglas del contrato de datos (objetos creados con DataContractAttribute y DataMemberAttribute).

Notas a los implementadores

Al heredar de XmlObjectSerializer, es necesario invalidar los miembros siguientes: WriteStartObject(XmlDictionaryWriter, Object), WriteObjectContent(XmlDictionaryWriter, Object), WriteEndObject(XmlDictionaryWriter). Además, deben implementarse los métodos IsStartObject y ReadObject para leer y serializar.

Constructores

XmlObjectSerializer()

Inicializa una nueva instancia de la clase XmlObjectSerializer.

Métodos

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)	Obtiene un valor que especifica si XmlDictionaryReader se coloca sobre un elemento XML que se puede leer.
IsStartObject(XmlReader)	Obtiene un valor que especifica si XmlReader se coloca sobre un elemento XML que se puede leer.
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.
ReadObject(XmlDictionaryReader)	Lee el documento o la secuencia XML con XmlDictionaryReader y devuelve el objeto deserializado.
ReadObject(XmlDictionaryReader, Boolean)	Lee la secuencia o el documento XML con XmlDictionaryReader y devuelve el objeto deserializado; también le permite especificar si el serializador puede leer los datos antes de intentar leerlos.
ReadObject(XmlReader)	Lee el documento o la secuencia XML con XmlReader y devuelve el objeto deserializado.
ReadObject(XmlReader, Boolean)	Lee el documento o la secuencia XML con XmlReader y devuelve el objeto deserializado; también le permite especificar si el serializador puede leer los datos antes de intentar leerlos.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
WriteEndObject(XmlDictionaryWriter)	Escribe el fin de los datos de objeto como un elemento XML de cierre en el documento o la secuencia XML con XmlDictionaryWriter.
WriteEndObject(XmlWriter)	Escribe el fin de los datos de objeto como un elemento XML de cierre en el documento o la secuencia XML con 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.
WriteObject(XmlDictionaryWriter, Object)	Escribe todo el contenido (inicio, contenido y fin) del objeto en el documento o la secuencia XML con el XmlDictionaryWriter especificado.
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 sólo el contenido del objeto en el documento o la secuencia XML con el XmlDictionaryWriter especificado.
WriteObjectContent(XmlWriter, Object)	Escribe sólo el contenido del objeto en el documento o la secuencia XML con el XmlWriter especificado.
WriteStartObject(XmlDictionaryWriter, Object)	Escribe el inicio de los datos del objeto como elemento XML de apertura con el XmlDictionaryWriter especificado.
WriteStartObject(XmlWriter, Object)	Escribe el inicio de los datos del objeto como elemento XML de apertura con el XmlWriter especificado.

Se aplica a

Compartir vía