IXmlSerializable Interfaccia

Definizione

Fornisce una formattazione personalizzata per la serializzazione e la deserializzazione XML.Provides custom formatting for XML serialization and deserialization.

public interface class IXmlSerializable
public interface IXmlSerializable
type IXmlSerializable = interface
Public Interface IXmlSerializable
Derivato

Esempi

Nell'esempio di codice seguente viene illustrata un' IXmlSerializable implementazione dell'interfaccia che serializza un campo privato.The following example code shows an implementation of the IXmlSerializable interface that serializes a private field.

#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;
using namespace System::Xml::Schema;
using namespace System::Xml::Serialization;
public ref class Person: public IXmlSerializable
{
private:

   // Private state
   String^ personName;

public:

   // Constructors
   Person( String^ name )
   {
      personName = name;
   }

   Person()
   {
      personName = nullptr;
   }

   // Xml Serialization Infrastructure
   virtual void WriteXml( XmlWriter^ writer )
   {
      writer->WriteString( personName );
   }

   virtual void ReadXml( XmlReader^ reader )
   {
      personName = reader->ReadString();
   }

   virtual XmlSchema^ GetSchema()
   {
      return nullptr;
   }

   // Print
   virtual String^ ToString() override
   {
      return (personName);
   }
};
using System;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;


public class Person : IXmlSerializable
{

    // Private state

    private string personName;
       

    // Constructors

    public Person (string name)
    {
        personName = name;
    }

    public Person ()
    {
        personName = null;
    }


    // Xml Serialization Infrastructure

    public void WriteXml (XmlWriter writer)
    {
        writer.WriteString(personName);
    }

    public void ReadXml (XmlReader reader)
    {
        personName = reader.ReadString();
    }

    public XmlSchema GetSchema()
    {
        return(null);
    }

  
    // Print

    public override string ToString()
    {
        return(personName);
    }

}

Commenti

Esistono due motivi per implementare questa interfaccia.There are two reasons to implement this interface. Il primo consiste nel controllare la modalità di serializzazione o deserializzazione dell'oggetto da XmlSerializerparte di.The first is to control how your object is serialized or deserialized by the XmlSerializer. Ad esempio, è possibile suddividere i dati in byte anziché memorizzare nel buffer set di dati di grandi dimensioni e anche evitare l'inflazione che si verifica quando i dati vengono codificati con la codifica Base64.For example, you can chunk data into bytes instead of buffering large data sets, and also avoid the inflation that occurs when the data is encoded using Base64 encoding. Per controllare la serializzazione, implementare ReadXml i WriteXml metodi e per controllare XmlReader le XmlWriter classi e usate per leggere e scrivere il codice XML.To control the serialization, implement the ReadXml and WriteXml methods to control the XmlReader and XmlWriter classes used to read and write the XML. Per un esempio, vedere procedura: Suddividere i datiserializzati.For an example of this, see How to: Chunk Serialized Data.

Il secondo motivo è quello di poter controllare lo schema.The second reason is to be able to control the schema. Per abilitare questa operazione, è necessario applicare XmlSchemaProviderAttribute al tipo serializzabile e specificare il nome del membro statico che restituisce lo schema.To enable this, you must apply the XmlSchemaProviderAttribute to the serializable type, and specify the name of the static member that returns the schema. Per un esempio, vedere XmlSchemaProviderAttribute.See the XmlSchemaProviderAttribute for an example.

Una classe che implementa l'interfaccia deve avere un costruttore senza parametri.A class that implements the interface must have a parameterless constructor. Si tratta di un requisito della XmlSerializer classe.This is a requirement of the XmlSerializer class.

Metodi

GetSchema()

Il metodo è riservato e non deve essere utilizzato.This method is reserved and should not be used. Quando si implementa l'interfaccia IXmlSerializable, è necessario restituire null (Nothing in Visual Basic) da questo metodo. Se invece è richiesta la specifica di uno schema personalizzato, applicare XmlSchemaProviderAttribute alla classe.When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.

ReadXml(XmlReader)

Genera un oggetto dalla relativa rappresentazione XML.Generates an object from its XML representation.

WriteXml(XmlWriter)

Converte un oggetto nella relativa rappresentazione XML.Converts an object into its XML representation.

Si applica a

Vedi anche