IXmlSerializable Interfejs

Odwołanie

Definicja

Przestrzeń nazw:: System.Xml.Serialization

Zestawy:: System.Xml.dll, System.Xml.ReaderWriter.dll

Zestawy:: netstandard.dll, System.Xml.ReaderWriter.dll

Zestaw:: System.Xml.ReaderWriter.dll

Zestaw:: System.Xml.dll

Zestaw:: netstandard.dll

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Zapewnia niestandardowe formatowanie serializacji i deserializacji XML.

public interface class IXmlSerializable

public interface IXmlSerializable

type IXmlSerializable = interface

Public Interface IXmlSerializable

Pochodne: System.Data.DataSet

System.Data.DataTable

System.Data.SqlTypes.SqlBinary

System.Data.SqlTypes.SqlBoolean

System.Data.SqlTypes.SqlByte

Więcej…

Przykłady

Poniższy przykładowy kod przedstawia implementację interfejsu IXmlSerializable , który serializuje pole prywatne.

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

Uwagi

Istnieją dwa powody, dla których należy zaimplementować ten interfejs. Pierwszą z nich jest kontrolowanie sposobu serializacji lub deserializacji obiektu przez XmlSerializerobiekt . Można na przykład podzielić dane na bajty zamiast buforować duże zestawy danych, a także uniknąć inflacji, która występuje, gdy dane są kodowane przy użyciu kodowania Base64. Aby kontrolować serializacji, zaimplementuj ReadXml metody i WriteXml do kontrolowania XmlReader klas i XmlWriter używanych do odczytywania i zapisywania kodu XML. Aby zapoznać się z tym przykładem, zobacz How to: Chunk Serialized Data (Instrukcje: fragment serializowane dane).

Drugim powodem jest możliwość kontrolowania schematu. Aby to włączyć, należy zastosować parametr XmlSchemaProviderAttribute do typu możliwego do serializacji i określić nazwę statycznego elementu członkowskiego zwracającego schemat. XmlSchemaProviderAttribute Zobacz przykład.

Klasa, która implementuje interfejs, musi mieć konstruktor bez parametrów. Jest to wymaganie XmlSerializer klasy.

Metody

GetSchema()	Ta metoda jest zarezerwowana i nie powinna być używana. Podczas implementowania interfejsu `IXmlSerializable` należy zwrócić (`nullNothing`w Visual Basic) z tej metody, a zamiast tego, jeśli określenie schematu niestandardowego jest wymagane, zastosuj element XmlSchemaProviderAttribute do klasy.
ReadXml(XmlReader)	Generuje obiekt na podstawie reprezentacji XML.
WriteXml(XmlWriter)	Konwertuje obiekt na reprezentację XML.

Dotyczy

Produkt	Wersje
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 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
.NET Standard	1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

Zobacz też

Wprowadzenie do serializacji XML

Udostępnij za pośrednictwem