XmlSerializer Konstruktory

Definicja

Przestrzeń nazw:

System.Xml.Serialization

Zestawy:

netstandard.dll, System.Xml.XmlSerializer.dll

Inicjuje nowe wystąpienie klasy XmlSerializer.

Przeciążenia

Nazwa	Opis
XmlSerializer()	Inicjuje nowe wystąpienie klasy XmlSerializer.
XmlSerializer(Type)	Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektów określonego typu.
XmlSerializer(XmlTypeMapping)	Inicjuje wystąpienie XmlSerializer klasy przy użyciu obiektu, który mapuje jeden typ na inny.
XmlSerializer(Type, String)	Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektów określonego typu. Określa domyślną przestrzeń nazw dla wszystkich elementów XML.
XmlSerializer(Type, Type[])	Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektu określonego typu. Jeśli właściwość lub pole zwraca tablicę, parametr określa obiekty, extraTypes które można wstawić do tablicy.
XmlSerializer(Type, XmlAttributeOverrides)	Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektów określonego typu. Każdy obiekt, który ma być serializowany, może zawierać wystąpienia klas, które to przeciążenie może zastąpić innymi klasami.
XmlSerializer(Type, XmlRootAttribute)	Inicjuje XmlSerializer nowe wystąpienie klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokument XML do obiektu określonego typu. Określa również klasę, która ma być używana jako element główny XML.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)	Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty typu Object w wystąpieniach dokumentów XML i deserializować wystąpienia dokumentów XML do obiektów typu Object. Każdy obiekt, który ma być serializowany, może zawierać wystąpienia klas, które to przeciążenie przesłania z innymi klasami. To przeciążenie określa również domyślną przestrzeń nazw dla wszystkich elementów XML i klasy do użycia jako element główny XML.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)	Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty typu Object w wystąpieniach dokumentów XML i deserializować wystąpienia dokumentów XML do obiektów typu Object. Każdy obiekt, który ma być serializowany, może zawierać wystąpienia klas, które to przeciążenie przesłania z innymi klasami. To przeciążenie określa również domyślną przestrzeń nazw dla wszystkich elementów XML i klasy do użycia jako element główny XML.

XmlSerializer()

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie klasy XmlSerializer.

protected:
 XmlSerializer();

protected XmlSerializer();

Protected Sub New ()

XmlSerializer(Type)

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektów określonego typu.

public:
 XmlSerializer(Type ^ type);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type)

Parametry

type

Type

Typ obiektu, który może serializować XmlSerializer .

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład tworzy obiekt XmlSerializer , który serializuje obiekt o nazwie Widget. W przykładzie ustawiane są różne właściwości obiektu przed wywołaniem Serialize metody .

private void SerializeObject(string filename)
{
   XmlSerializer serializer =
   new XmlSerializer(typeof(OrderedItem));

   // Create an instance of the class to be serialized.
   OrderedItem i = new OrderedItem();

   // Set the public property values.
   i.ItemName = "Widget";
   i.Description = "Regular Widget";
   i.Quantity = 10;
   i.UnitPrice = (decimal) 2.30;

   // Writing the document requires a TextWriter.
   TextWriter writer = new StreamWriter(filename);

   // Serialize the object, and close the TextWriter.
   serializer.Serialize(writer, i);
   writer.Close();
}

// This is the class that will be serialized.
public class OrderedItem
{
   public string ItemName;
   public string Description;
   public decimal UnitPrice;
   public int Quantity;
}

Private Sub SerializeObject(ByVal filename As String)
    Dim serializer As New XmlSerializer(GetType(OrderedItem))
    
    ' Create an instance of the class to be serialized.
    Dim i As New OrderedItem()
    
    ' Set the public property values.
    With i
        .ItemName = "Widget"
        .Description = "Regular Widget"
        .Quantity = 10
        .UnitPrice = CDec(2.3)
    End With
    
    ' Writing the document requires a TextWriter.
    Dim writer As New StreamWriter(filename)
    
    ' Serialize the object, and close the TextWriter.
    serializer.Serialize(writer, i)
    writer.Close()
End Sub


' This is the class that will be serialized.
Public Class OrderedItem
    Public ItemName As String
    Public Description As String
    Public UnitPrice As Decimal
    Public Quantity As Integer
End Class

Uwagi

Często aplikacja definiuje kilka klas, które XmlSerializer konwertuje na pojedynczy dokument wystąpienia XML. XmlSerializer Musi jednak znać tylko jeden typ — typ klasy reprezentującej element główny XML. Funkcja XmlSerializer automatycznie serializuje wszystkie wystąpienia klas podrzędnych. Podobnie tylko typ elementu głównego XML jest wymagany do deserializacji.

Zobacz też

• Serialize(TextWriter, Object)
• Deserialize(Stream)
• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(XmlTypeMapping)

Źródło:

XmlSerializer.cs

Inicjuje wystąpienie XmlSerializer klasy przy użyciu obiektu, który mapuje jeden typ na inny.

public:
 XmlSerializer(System::Xml::Serialization::XmlTypeMapping ^ xmlTypeMapping);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(System.Xml.Serialization.XmlTypeMapping xmlTypeMapping);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : System.Xml.Serialization.XmlTypeMapping -> System.Xml.Serialization.XmlSerializer

Public Sub New (xmlTypeMapping As XmlTypeMapping)

Parametry

xmlTypeMapping

XmlTypeMapping

Element XmlTypeMapping , który mapuje jeden typ na inny.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład serializuje klasę o nazwie Group. Serializacja GroupNamepól , IgnoreThis i składowych GroupType wyliczenia są zastępowane. W metodzie CreateOverrideSerializerSoapAttributeOverrides tworzony jest obiekt, a dla każdego przesłoniętego elementu członkowskiego lub wyliczenia SoapAttributes obiekt jest tworzony z odpowiednim zestawem właściwości i dodawany do SoapAttributeOverrides obiektu. Obiekt XmlMapping jest tworzony przy użyciu SoapAttributeOverrides obiektu , a XmlMapping ten obiekt jest używany do utworzenia XmlSerializer obiektu, który zastępuje domyślną serializacji.

using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;

public class Group
{
   [SoapAttribute (Namespace = "http://www.cpandl.com")]
   public string GroupName;

   [SoapAttribute(DataType = "base64Binary")]
   public Byte [] GroupNumber;

   [SoapAttribute(DataType = "date", AttributeName = "CreationDate")]
   public DateTime Today;
   [SoapElement(DataType = "nonNegativeInteger", ElementName = "PosInt")]
   public string PostitiveInt;
   // This is ignored when serialized unless it's overridden.
   [SoapIgnore]
   public bool IgnoreThis;

   public GroupType Grouptype;

   public Vehicle MyVehicle;

   // The SoapInclude allows the method to return a Car.
   [SoapInclude(typeof(Car))]
   public Vehicle myCar(string licNumber)
   {
      Vehicle v;
      if(licNumber == "")
         {
            v = new Car();
        v.licenseNumber = "!!!!!!";
     }
      else
     {
       v = new Car();
       v.licenseNumber = licNumber;
     }
      return v;
   }
}

// SoapInclude allows Vehicle to accept Car type.
[SoapInclude(typeof(Car))]
public abstract class Vehicle
{
   public string licenseNumber;
   public DateTime makeDate;
}

public class Car: Vehicle
{
}

public enum GroupType
{
   // These enums can be overridden.
   [SoapEnum("Small")]
   A,
   [SoapEnum("Large")]
   B
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeOriginal("SoapOriginal.xml");
      test.SerializeOverride("SoapOverrides.xml");
      test.DeserializeOriginal("SoapOriginal.xml");
      test.DeserializeOverride("SoapOverrides.xml");
   }
   public void SerializeOriginal(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlTypeMapping myMapping =
      (new SoapReflectionImporter().ImportTypeMapping(
      typeof(Group)));
      XmlSerializer mySerializer =
      new XmlSerializer(myMapping);
      Group myGroup=MakeGroup();
      // Writing the file requires a TextWriter.
      XmlTextWriter writer =
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
      writer.WriteEndElement();
      writer.Close();
   }

   public void SerializeOverride(string filename)
   {
      // Create an instance of the XmlSerializer class
      // that overrides the serialization.
      XmlSerializer overRideSerializer = CreateOverrideSerializer();
      Group myGroup=MakeGroup();
      // Writing the file requires a TextWriter.
      XmlTextWriter writer =
      new XmlTextWriter(filename, Encoding.UTF8);
      writer.Formatting = Formatting.Indented;
      writer.WriteStartElement("wrapper");
      // Serialize the class, and close the TextWriter.
      overRideSerializer.Serialize(writer, myGroup);
      writer.WriteEndElement();
      writer.Close();
   }

   private Group MakeGroup(){
      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      myGroup.GroupName = ".NET";

      Byte [] hexByte = new Byte[2]{Convert.ToByte(100),
      Convert.ToByte(50)};
      myGroup.GroupNumber = hexByte;

      DateTime myDate = new DateTime(2002,5,2);
      myGroup.Today = myDate;
      myGroup.PostitiveInt= "10000";
      myGroup.IgnoreThis=true;
      myGroup.Grouptype= GroupType.B;
      Car thisCar =(Car)  myGroup.myCar("1234566");
      myGroup.MyVehicle=thisCar;
      return myGroup;
   }   	

   public void DeserializeOriginal(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlTypeMapping myMapping =
      (new SoapReflectionImporter().ImportTypeMapping(
      typeof(Group)));
      XmlSerializer mySerializer =
      new XmlSerializer(myMapping);

      // Reading the file requires an  XmlTextReader.
      XmlTextReader reader=
      new XmlTextReader(filename);
      reader.ReadStartElement("wrapper");

      // Deserialize and cast the object.
      Group myGroup;
      myGroup = (Group) mySerializer.Deserialize(reader);
      reader.ReadEndElement();
      reader.Close();
   }

   public void DeserializeOverride(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer overRideSerializer = CreateOverrideSerializer();

      // Reading the file requires an  XmlTextReader.
      XmlTextReader reader=
      new XmlTextReader(filename);
      reader.ReadStartElement("wrapper");

      // Deserialize and cast the object.
      Group myGroup;
      myGroup = (Group) overRideSerializer.Deserialize(reader);
      reader.ReadEndElement();
      reader.Close();
      ReadGroup(myGroup);
   }

   private void ReadGroup(Group myGroup){
      Console.WriteLine(myGroup.GroupName);
      Console.WriteLine(myGroup.GroupNumber[0]);
      Console.WriteLine(myGroup.GroupNumber[1]);
      Console.WriteLine(myGroup.Today);
      Console.WriteLine(myGroup.PostitiveInt);
      Console.WriteLine(myGroup.IgnoreThis);
      Console.WriteLine();
   }
   private XmlSerializer CreateOverrideSerializer()
   {
      SoapAttributeOverrides mySoapAttributeOverrides =
      new SoapAttributeOverrides();
      SoapAttributes soapAtts = new SoapAttributes();

      SoapElementAttribute mySoapElement = new SoapElementAttribute();
      mySoapElement.ElementName = "xxxx";
      soapAtts.SoapElement = mySoapElement;
      mySoapAttributeOverrides.Add(typeof(Group), "PostitiveInt",
      soapAtts);

      // Override the IgnoreThis property.
      SoapIgnoreAttribute myIgnore = new SoapIgnoreAttribute();
      soapAtts = new SoapAttributes();
      soapAtts.SoapIgnore = false;
      mySoapAttributeOverrides.Add(typeof(Group), "IgnoreThis",
      soapAtts);

      // Override the GroupType enumeration.	
      soapAtts = new SoapAttributes();
      SoapEnumAttribute xSoapEnum = new SoapEnumAttribute();
      xSoapEnum.Name = "Over1000";
      soapAtts.SoapEnum = xSoapEnum;

      // Add the SoapAttributes to the
      // mySoapAttributeOverridesrides object.
      mySoapAttributeOverrides.Add(typeof(GroupType), "A",
      soapAtts);

      // Create second enumeration and add it.
      soapAtts = new SoapAttributes();
      xSoapEnum = new SoapEnumAttribute();
      xSoapEnum.Name = "ZeroTo1000";
      soapAtts.SoapEnum = xSoapEnum;
      mySoapAttributeOverrides.Add(typeof(GroupType), "B",
      soapAtts);

      // Override the Group type.
      soapAtts = new SoapAttributes();
      SoapTypeAttribute soapType = new SoapTypeAttribute();
      soapType.TypeName = "Team";
      soapAtts.SoapType = soapType;
      mySoapAttributeOverrides.Add(typeof(Group),soapAtts);

      // Create an XmlTypeMapping that is used to create an instance
      // of the XmlSerializer. Then return the XmlSerializer object.
      XmlTypeMapping myMapping = (new SoapReflectionImporter(
      mySoapAttributeOverrides)).ImportTypeMapping(typeof(Group));
    
      XmlSerializer ser = new XmlSerializer(myMapping);
      return ser;
   }
}

Imports System.IO
Imports System.Text
Imports System.Xml
Imports System.Xml.Serialization
Imports System.Xml.Schema

Public Class Group
   <SoapAttribute (Namespace:= "http:'www.cpandl.com")> _
   Public GroupName As String 
   
   <SoapAttribute(DataType:= "base64Binary")> _
   Public GroupNumber() As Byte

   <SoapAttribute(DataType:= "date", _
   AttributeName:= "CreationDate")> _
   Public Today As DateTime 
   <SoapElement(DataType:= "nonNegativeInteger", _
   ElementName:= "PosInt")> _
   Public PostitiveInt As String 
   ' This is ignored when serialized unless it's overridden.
   <SoapIgnore> _ 
   Public IgnoreThis As Boolean 
   
   Public Grouptype As GroupType 

   Public MyVehicle As Vehicle 

   '  The SoapInclude allows the method to return a Car.
   <SoapInclude(GetType(Car))> _
   Public Function myCar(licNumber As String ) As Vehicle 
      Dim v As Vehicle 
      if licNumber = "" Then
         v = New Car()
         v.licenseNumber = "!!!!!!"
      else  
       v = New Car()
       v.licenseNumber = licNumber
      End If
      
      return v
   End Function
End Class
  
' SoapInclude allows Vehicle to accept Car type.
<SoapInclude(GetType(Car))> _
Public MustInherit  class Vehicle
   Public licenseNumber As String 
   Public makeDate As DateTime 
End Class

Public Class Car
   Inherits Vehicle

End Class

Public enum GroupType
   ' These enums can be overridden.
   <SoapEnum("Small")> _
   A
   <SoapEnum("Large")> _ 
   B
End Enum
 
Public Class Run

   Shared Sub Main()
      Dim test As Run = New Run()
      test.SerializeOriginal("SoapOriginal.xml")
      test.SerializeOverride("SoapOverrides.xml")
      test.DeserializeOriginal("SoapOriginal.xml")
      test.DeserializeOverride("SoapOverrides.xml")
   End SUb
   
   Public Sub SerializeOriginal(filename As String)

      ' Create an instance of the XmlSerializer class.
      Dim myMapping As XmlTypeMapping = _
      (New SoapReflectionImporter().ImportTypeMapping _
      (GetType(Group)))
      Dim mySerializer As XmlSerializer =  _
      New XmlSerializer(myMapping)
      
      Dim myGroup As Group =MakeGroup()
      ' Writing the file requires a TextWriter.
      Dim writer As XmlTextWriter  = _
      New XmlTextWriter(filename, Encoding.UTF8)
      writer.Formatting = Formatting.Indented
      writer.WriteStartElement("wrapper")
      ' Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup)
      writer.WriteEndElement()
      writer.Close()
   End Sub

   Public Sub SerializeOverride(filename As String)
      ' Create an instance of the XmlSerializer class
      ' that overrides the serialization.
      Dim overRideSerializer As XmlSerializer = _
      CreateOverrideSerializer()
      Dim myGroup As Group =MakeGroup()
      ' Writing the file requires a TextWriter.
      Dim writer As XmlTextWriter  = _
      New XmlTextWriter(filename, Encoding.UTF8)
      writer.Formatting = Formatting.Indented
      writer.WriteStartElement("wrapper")
      ' Serialize the class, and close the TextWriter.
      overRideSerializer.Serialize(writer, myGroup)
      writer.WriteEndElement()
      writer.Close()
    End Sub

   private Function MakeGroup() As Group 
      ' Create an instance of the class that will be serialized.
      Dim myGroup As Group  = New Group()

      ' Set the object properties.
      myGroup.GroupName = ".NET"

      Dim hexByte()As Byte = new Byte(1){Convert.ToByte(100), _
      Convert.ToByte(50)}
      myGroup.GroupNumber = hexByte

      Dim myDate As DateTime  = new DateTime(2002,5,2)
      myGroup.Today = myDate

      myGroup.PostitiveInt = "10000"
    myGroup.IgnoreThis = true
    myGroup.Grouptype = GroupType.B
    Dim thisCar As Car 
    thisCar =CType(myGroup.myCar("1234566"), Car)
    myGroup.myVehicle=thisCar
      return myGroup
   End Function   	

   Public Sub DeserializeOriginal(filename As String)
      ' Create an instance of the XmlSerializer class.
      Dim myMapping As XmlTypeMapping = _
      (New SoapReflectionImporter().ImportTypeMapping _
      (GetType(Group)))
      Dim mySerializer As XmlSerializer =  _
      New XmlSerializer(myMapping)

      ' Reading the file requires an  XmlTextReader.
      Dim reader As XmlTextReader = _
      New XmlTextReader(filename)
      reader.ReadStartElement("wrapper")

      ' Deserialize and cast the object.
      Dim myGroup As Group  = _
      CType(mySerializer.Deserialize(reader), Group)
      reader.ReadEndElement()
      reader.Close()
   End Sub

   Public Sub DeserializeOverride(filename As String)
      ' Create an instance of the XmlSerializer class.
      Dim overRideSerializer As XmlSerializer  = _
      CreateOverrideSerializer()

      ' Reading the file requires an  XmlTextReader.
      Dim reader As XmlTextReader = _
      New XmlTextReader(filename)
      reader.ReadStartElement("wrapper")

      ' Deserialize and cast the object.
      Dim myGroup As Group = _
      CType(overRideSerializer.Deserialize(reader), Group)
      reader.ReadEndElement()
      reader.Close()
      ReadGroup(myGroup)
   End Sub

   private Sub ReadGroup(myGroup As Group)
      Console.WriteLine(myGroup.GroupName)
      Console.WriteLine(myGroup.GroupNumber(0))
      Console.WriteLine(myGroup.GroupNumber(1))
      Console.WriteLine(myGroup.Today)
      Console.WriteLine(myGroup.PostitiveInt)
      Console.WriteLine(myGroup.IgnoreThis)
      Console.WriteLine()
   End Sub
   
   Private Function CreateOverrideSerializer() As XmlSerializer
      Dim soapOver As SoapAttributeOverrides = New SoapAttributeOverrides()
      Dim soapAtts As SoapAttributes = New SoapAttributes()

      Dim mySoapElement As SoapElementAttribute = New SoapElementAttribute()
      mySoapElement.ElementName = "xxxx"
      soapAtts.SoapElement = mySoapElement
      soapOver.Add(GetType(Group), "PostitiveInt", soapAtts)

      ' Override the IgnoreThis property.
      Dim myIgnore As SoapIgnoreAttribute  = new SoapIgnoreAttribute()
      soapAtts = New SoapAttributes()
      soapAtts.SoapIgnore = false
      soapOver.Add(GetType(Group), "IgnoreThis", soapAtts)

      ' Override the GroupType enumeration.
      soapAtts = New SoapAttributes()
      Dim xSoapEnum As SoapEnumAttribute = new SoapEnumAttribute()
      xSoapEnum.Name = "Over1000"
      soapAtts.SoapEnum = xSoapEnum
      ' Add the SoapAttributes to the SoapOverrides object.
      soapOver.Add(GetType(GroupType), "A", soapAtts)

      ' Create second enumeration and add it.
      soapAtts = New SoapAttributes()
      xSoapEnum = New SoapEnumAttribute()
      xSoapEnum.Name = "ZeroTo1000"
      soapAtts.SoapEnum = xSoapEnum
      soapOver.Add(GetType(GroupType), "B", soapAtts)

      ' Override the Group type.
      soapAtts = New SoapAttributes()
      Dim soapType As SoapTypeAttribute = New SoapTypeAttribute()
      soapType.TypeName = "Team"
      soapAtts.SoapType = soapType
      soapOver.Add(GetType(Group),soapAtts)
    
      Dim myMapping As XmlTypeMapping = (New SoapReflectionImporter( _
      soapOver)).ImportTypeMapping(GetType(Group))
    
       Dim ser As XmlSerializer = new XmlSerializer(myMapping)
      return ser
   End Function
End Class

Uwagi

Ten konstruktor służy do tworzenia XmlSerializer obiektu podczas serializacji obiektu do komunikatu PROTOKOŁU SOAP. Aby kontrolować wygenerowane komunikaty PROTOKOŁU SOAP, użyj atrybutów specjalnych (począwszy od słowa "Soap") znalezionego System.Xml.Serialization w przestrzeni nazw.

Zobacz też

• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(Type, String)

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektów określonego typu. Określa domyślną przestrzeń nazw dla wszystkich elementów XML.

public:
 XmlSerializer(Type ^ type, System::String ^ defaultNamespace);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type, string? defaultNamespace);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type * string -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type, defaultNamespace As String)

Parametry

type

Type

Typ obiektu, który może serializować XmlSerializer .

defaultNamespace

String

Domyślna przestrzeń nazw do użycia dla wszystkich elementów XML.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład tworzy obiekt XmlSerializer , który serializuje obiekt o nazwie Widget. W przykładzie ustawiane są różne właściwości obiektu przed wywołaniem Serialize metody .

private void SerializeObject(string filename) {
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem), "http://www.cpandl.com");

    // Create an instance of the class to be serialized.
    OrderedItem i = new OrderedItem();

    // Insert code to set property values.

    // Writing the document requires a TextWriter.
    TextWriter writer = new StreamWriter(filename);
    // Serialize the object, and close the TextWriter
    serializer.Serialize(writer, i);
    writer.Close();
}

private void DeserializeObject(string filename) {
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem), "http://www.cpandl.com");
    // A FileStream is needed to read the XML document.
    FileStream fs = new FileStream(filename, FileMode.Open);

    // Declare an object variable of the type to be deserialized.
    OrderedItem i;

    // Deserialize the object.
    i = (OrderedItem) serializer.Deserialize(fs);

    // Insert code to use the properties and methods of the object.
}

Private Sub SerializeObject(ByVal filename As String)
    Dim serializer As New XmlSerializer(GetType(OrderedItem), _
                                          "http://www.cpandl.com")
    
    ' Create an instance of the class to be serialized.
    Dim i As New OrderedItem()
    
    ' Insert code to set property values.
    ' Writing the document requires a TextWriter.
    Dim writer As New StreamWriter(filename)
    ' Serialize the object, and close the TextWriter.
    serializer.Serialize(writer, i)
    writer.Close()
End Sub


Private Sub DeserializeObject(ByVal filename As String)
    Dim serializer As New XmlSerializer(GetType(OrderedItem), _
                                          "http://www.cpandl.com")
    ' A FileStream is needed to read the XML document.
    Dim fs As New FileStream(filename, FileMode.Open)
    
    ' Declare an object variable of the type to be deserialized.
    Dim i As OrderedItem
    
    ' Deserialize the object.
    i = CType(serializer.Deserialize(fs), OrderedItem)
    ' Insert code to use the properties and methods of the object.
End Sub

Zobacz też

• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(Type, Type[])

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektu określonego typu. Jeśli właściwość lub pole zwraca tablicę, parametr określa obiekty, extraTypes które można wstawić do tablicy.

public:
 XmlSerializer(Type ^ type, cli::array <Type ^> ^ extraTypes);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type, Type[]? extraTypes);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type * Type[] -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type, extraTypes As Type())

Parametry

type

Type

Typ obiektu, który może serializować XmlSerializer .

extraTypes

Type[]

Tablica Type dodatkowych typów obiektów do serializacji.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład serializuje wystąpienie klasy zawierające pole publiczne zwracające tablicę obiektów. Parametr extraTypesXmlSerializer konstruktora określa typy obiektów, które można serializować w tablicy.

using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;

// This defines the object that will be serialized.
public class Teacher
{
   public string Name;
   public Teacher(){}
   /* Note that the Info field returns an array of objects.
      Any object can be added to the array by adding the
      object type to the array passed to the extraTypes argument. */
   [XmlArray (ElementName = "ExtraInfo", IsNullable = true)]
   public object[] Info;
   public Phone PhoneInfo;
}

// This defines one of the extra types to be included.
public class Address
{
   public string City;

   public Address(){}
   public Address(string city)
   {
      City = city;
   }
}

// Another extra type to include.
public class Phone
{
   public string PhoneNumber;
   public Phone(){}
   public Phone(string phoneNumber)
   {
      PhoneNumber = phoneNumber;
   }
}

// Another type, derived from Phone
public class InternationalPhone:Phone
{
   public string CountryCode;

   public InternationalPhone(){}

   public InternationalPhone(string countryCode)
   {
      CountryCode = countryCode;
   }
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("Teacher.xml");
      test.DeserializeObject("Teacher.xml");
   }

   private void SerializeObject(string filename)
   {
      // Writing the file requires a TextWriter.
      TextWriter myStreamWriter = new StreamWriter(filename);

      // Create a Type array.
      Type [] extraTypes= new Type[3];
      extraTypes[0] = typeof(Address);
      extraTypes[1] = typeof(Phone);
      extraTypes[2] = typeof(InternationalPhone);

      // Create the XmlSerializer instance.
      XmlSerializer mySerializer = new XmlSerializer
      (typeof(Teacher),extraTypes);

      Teacher teacher = new Teacher();
      teacher.Name = "Mike";
      // Add extra types to the Teacher object
      object [] info = new object[2];
      info[0] = new Address("Springville");
      info[1] = new Phone("555-0100");

      teacher.Info = info;

      teacher.PhoneInfo = new InternationalPhone("000");

      mySerializer.Serialize(myStreamWriter,teacher);
      myStreamWriter.Close();
   }

   private void DeserializeObject(string filename)
   {
      // Create a Type array.
      Type [] extraTypes= new Type[3];
      extraTypes[0] = typeof(Address);
      extraTypes[1] = typeof(Phone);
      extraTypes[2] = typeof(InternationalPhone);

      // Create the XmlSerializer instance.
      XmlSerializer mySerializer = new XmlSerializer
      (typeof(Teacher),extraTypes);

      // Reading a file requires a FileStream.
      FileStream fs = new FileStream(filename, FileMode.Open);
      Teacher teacher = (Teacher) mySerializer.Deserialize(fs);

      // Read the extra information.
      Address a = (Address)teacher.Info[0];
      Phone p = (Phone) teacher.Info[1];
      InternationalPhone Ip =
      (InternationalPhone) teacher.PhoneInfo;

      Console.WriteLine(teacher.Name);
      Console.WriteLine(a.City);
      Console.WriteLine(p.PhoneNumber);
      Console.WriteLine(Ip.CountryCode);
   }
}

Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization



' This defines the object that will be serialized.
Public Class Teacher
    Public Name As String
    
    Public Sub New()
    End Sub
    ' Note that the Info field returns an array of objects.
    ' Any object can be added to the array by adding the
    ' object type to the array passed to the extraTypes argument. 
    <XmlArray(ElementName := "ExtraInfo", IsNullable := True)> _
    Public Info() As Object
    Public PhoneInfo As Phone
End Class


' This defines one of the extra types to be included.
Public Class Address
    Public City As String
    
    Public Sub New()
    End Sub
    
    Public Sub New(city As String)
        me.City = city
    End Sub
End Class
 

' Another extra type to include.
Public Class Phone
    Public PhoneNumber As String
    
    Public Sub New()
    End Sub
    
    Public Sub New(phoneNumber As String)
        me.PhoneNumber = phoneNumber
    End Sub
End Class


' Another type, derived from Phone.
Public Class InternationalPhone
    Inherits Phone
    Public CountryCode As String
    
    
    Public Sub New()
    End Sub
     
    Public Sub New(countryCode As String)
        me.CountryCode = countryCode
    End Sub
End Class


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Teacher.xml")
        test.DeserializeObject("Teacher.xml")
    End Sub
    
    
    Private Sub SerializeObject(filename As String)
        ' Writing the file requires a TextWriter.
        Dim myStreamWriter As New StreamWriter(filename)
        
        ' Create a Type array.
        Dim extraTypes(2) As Type
        extraTypes(0) = GetType(Address)
        extraTypes(1) = GetType(Phone)
        extraTypes(2) = GetType(InternationalPhone)
        
        ' Create the XmlSerializer instance.
        Dim mySerializer As New XmlSerializer(GetType(Teacher), extraTypes)
        
        Dim teacher As New Teacher()
        teacher.Name = "Mike"
        ' Add extra types to the Teacher object.
        Dim info(1) As Object
        info(0) = New Address("Springville")
        info(1) = New Phone("555-0100")
        
        teacher.Info = info
        
        teacher.PhoneInfo = New InternationalPhone("000")
        
        mySerializer.Serialize(myStreamWriter, teacher)
        myStreamWriter.Close()
    End Sub
    
    
    Private Sub DeserializeObject(filename As String)
        ' Create a Type array.
        Dim extraTypes(2) As Type
        extraTypes(0) = GetType(Address)
        extraTypes(1) = GetType(Phone)
        extraTypes(2) = GetType(InternationalPhone)
        
        ' Create the XmlSerializer instance.
        Dim mySerializer As New XmlSerializer(GetType(Teacher), extraTypes)
        
        ' Reading a file requires a FileStream.
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim teacher As Teacher = CType(mySerializer.Deserialize(fs), Teacher)
        
        ' Read the extra information.
        Dim a As Address = CType(teacher.Info(0), Address)
        Dim p As Phone = CType(teacher.Info(1), Phone)
        Dim Ip As InternationalPhone = CType(teacher.PhoneInfo, InternationalPhone)
        
        Console.WriteLine(teacher.Name)
        Console.WriteLine(a.City)
        Console.WriteLine(p.PhoneNumber)
        Console.WriteLine(Ip.CountryCode)
    End Sub
End Class

Uwagi

Domyślnie, jeśli właściwość publiczna lub pole zwraca obiekt lub tablicę obiektów, typy obiektów są automatycznie serializowane. Jeśli jednak klasa zawiera pole lub właściwość zwracającą tablicę typu Object, do tej tablicy można wstawić dowolny obiekt. W takim przypadku należy poinstruować, XmlSerializer aby oczekiwać wszystkich możliwych typów obiektów wstawionych do tablicy Object . W tym celu użyj parametru extraTypes , aby określić dodatkowe typy obiektów do serializacji lub deserializacji.

Można również użyć parametru extraTypes , aby określić typy pochodzące z klasy bazowej. Załóżmy na przykład, że istnieje klasa bazowa o nazwie Phone , a klasa o nazwie InternationalPhone pochodzi od niej. Użyj parametru extraTypes , aby określić również typ pochodny.

Zobacz też

• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(Type, XmlAttributeOverrides)

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokumenty XML do obiektów określonego typu. Każdy obiekt, który ma być serializowany, może zawierać wystąpienia klas, które to przeciążenie może zastąpić innymi klasami.

public:
 XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides? overrides);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type, overrides As XmlAttributeOverrides)

Parametry

type

Type

Typ obiektu do serializacji.

overrides

XmlAttributeOverrides

Jeden XmlAttributeOverrides.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład serializuje wystąpienie klasy zdefiniowanej w dll i w tym celu zastępuje publiczne elementy członkowskie znalezione w dll.

// Beginning of HighSchool.dll
namespace HighSchool
{
   public class Student
   {
      public string Name;
      public int ID;
   }

   public class MyClass
   {
      public Student[] Students;
   }
}

namespace College
   {
   using System;
   using System.IO;
   using System.Xml;
   using System.Xml.Serialization;
   using HighSchool;

    public class Graduate:HighSchool.Student
    {
       public Graduate(){}
       // Add a new field named University.
       public string University;
    }

   public class Run
   {
      public static void Main()
      {
         Run test = new Run();
         test.WriteOverriddenAttributes("College.xml");
         test.ReadOverriddenAttributes("College.xml");
      }

      private void WriteOverriddenAttributes(string filename)
      {
         // Writing the file requires a TextWriter.
         TextWriter myStreamWriter = new StreamWriter(filename);
         // Create an XMLAttributeOverrides class.
         XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
         // Create the XmlAttributes class.
         XmlAttributes attrs = new XmlAttributes();

         /* Override the Student class. "Alumni" is the name
         of the overriding element in the XML output. */
         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));

         /* Add the XmlElementAttribute to the collection of
         elements in the XmlAttributes object. */
         attrs.XmlElements.Add(attr);

         /* Add the XmlAttributes to the XmlAttributeOverrides.
         "Students" is the name being overridden. */
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         // Create the XmlSerializer.
         XmlSerializer mySerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides);

         MyClass myClass = new MyClass();

         Graduate g1 = new Graduate();
         g1.Name = "Jackie";
         g1.ID = 1;
         g1.University = "Alma Mater";

         Graduate g2 = new Graduate();
         g2.Name = "Megan";
         g2.ID = 2;
         g2.University = "CM";

         Student[] myArray = {g1,g2};
         myClass.Students = myArray;

         mySerializer.Serialize(myStreamWriter, myClass);
         myStreamWriter.Close();
      }

      private void ReadOverriddenAttributes(string filename)
      {
         /* The majority of the code here is the same as that in the
         WriteOverriddenAttributes method. Because the XML being read
         doesn't conform to the schema defined by the DLL, the
         XMLAttributesOverrides must be used to create an
         XmlSerializer instance to read the XML document.*/

         XmlAttributeOverrides attrOverrides = new
         XmlAttributeOverrides();
         XmlAttributes attrs = new XmlAttributes();
         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));
         attrs.XmlElements.Add(attr);
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         XmlSerializer readSerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides);

         // To read the file, a FileStream object is required.
         FileStream fs = new FileStream(filename, FileMode.Open);

         MyClass myClass;

         myClass = (MyClass) readSerializer.Deserialize(fs);

         /* Here is the difference between reading and writing an
         XML document: You must declare an object of the derived
         type (Graduate) and cast the Student instance to it.*/
         Graduate g;

         foreach(Graduate grad in myClass.Students)
         {
            g = (Graduate) grad;
            Console.Write(g.Name + "\t");
            Console.Write(g.ID + "\t");
            Console.Write(g.University + "\n");
         }
      }
   }
}

' Beginning of HighSchool.dll
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
Imports HighSchool

Namespace HighSchool
    
    Public Class Student
        Public Name As String
        Public ID As Integer
    End Class
    
    
    Public Class MyClass1
        Public Students() As Student
    End Class
End Namespace 'HighSchool

Namespace College
    Public Class Graduate
        Inherits HighSchool.Student
        
        Public Sub New()
        End Sub
        Public University As String
    End Class
    
    
    
    Public Class Run
        
        Public Shared Sub Main()
            Dim test As New Run()
            test.WriteOverriddenAttributes("College.xml")
            test.ReadOverriddenAttributes("College.xml")
        End Sub
        
        
        Private Sub WriteOverriddenAttributes(filename As String)
            ' Writing the file requires a TextWriter.
            Dim myStreamWriter As New StreamWriter(filename)
            ' Create an XMLAttributeOverrides class.
            Dim attrOverrides As New XmlAttributeOverrides()
            ' Create the XmlAttributes class.
            Dim attrs As New XmlAttributes()
            
            ' Override the Student class. "Alumni" is the name
            ' of the overriding element in the XML output. 
            Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
            
            ' Add the XmlElementAttribute to the collection of
            ' elements in the XmlAttributes object. 
            attrs.XmlElements.Add(attr)
            
            ' Add the XmlAttributes to the XmlAttributeOverrides. 
            ' "Students" is the name being overridden. 
            attrOverrides.Add(GetType(HighSchool.MyClass1), "Students", attrs)
            
            ' Create the XmlSerializer. 
            Dim mySerializer As New XmlSerializer(GetType(HighSchool.MyClass1), attrOverrides)
            
            Dim oMyClass As New MyClass1()
            
            Dim g1 As New Graduate()
            g1.Name = "Jackie"
            g1.ID = 1
            g1.University = "Alma Mater"
            
            Dim g2 As New Graduate()
            g2.Name = "Megan"
            g2.ID = 2
            g2.University = "CM"
            
            Dim myArray As Student() =  {g1, g2}
            oMyClass.Students = myArray
            
            mySerializer.Serialize(myStreamWriter, oMyClass)
            myStreamWriter.Close()
        End Sub
        
        
        Private Sub ReadOverriddenAttributes(filename As String)
            ' The majority of the code here is the same as that in the
            ' WriteOverriddenAttributes method. Because the XML being read
            ' doesn't conform to the schema defined by the DLL, the
            ' XMLAttributesOverrides must be used to create an
            ' XmlSerializer instance to read the XML document.
            
            Dim attrOverrides As New XmlAttributeOverrides()
            Dim attrs As New XmlAttributes()
            Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
            attrs.XmlElements.Add(attr)
            attrOverrides.Add(GetType(HighSchool.MyClass1), "Students", attrs)
            
            Dim readSerializer As New XmlSerializer(GetType(HighSchool.MyClass1), attrOverrides)
            
            ' To read the file, a FileStream object is required. 
            Dim fs As New FileStream(filename, FileMode.Open)
            
            Dim oMyClass As MyClass1
            
            oMyClass = CType(readSerializer.Deserialize(fs), MyClass1)
            
            ' Here is the difference between reading and writing an
            ' XML document: You must declare an object of the derived
            ' type (Graduate) and cast the Student instance to it.
            Dim g As Graduate
            
            Dim grad As Graduate
            For Each grad In  oMyClass.Students
                g = CType(grad, Graduate)
                Console.Write((g.Name & ControlChars.Tab))
                Console.Write((g.ID.ToString & ControlChars.Tab))
                Console.Write((g.University & ControlChars.Cr))
            Next grad
        End Sub
    End Class
End Namespace 'College

Uwagi

Parametr może służyć do kontrolowania overrides sposobu kodowania pól i właściwości w formacie XML. Te ustawienia zastępują wszystkie atrybuty, które już istnieją w obiektach. Może to być przydatne, gdy nie można zmodyfikować kodu źródłowego lub dla tych samych klas jest wymaganych wiele kodowań.

Zobacz też

• XmlAttributeOverrides
• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(Type, XmlRootAttribute)

Źródło:

XmlSerializer.cs

Inicjuje XmlSerializer nowe wystąpienie klasy, które może serializować obiekty określonego typu w dokumentach XML i deserializować dokument XML do obiektu określonego typu. Określa również klasę, która ma być używana jako element główny XML.

public:
 XmlSerializer(Type ^ type, System::Xml::Serialization::XmlRootAttribute ^ root);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type, System.Xml.Serialization.XmlRootAttribute? root);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlRootAttribute -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type, root As XmlRootAttribute)

Parametry

type

Type

Typ obiektu, który może serializować XmlSerializer .

root

XmlRootAttribute

Element XmlRootAttribute reprezentujący element główny XML.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład tworzy obiekt XmlSerializer , który używa elementu XmlRootAttribute zawierającego różne właściwości elementu głównego XML, takie jak jego przestrzeń nazw i nazwa elementu.

private void SerializeObject(string filename) {
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.ElementName = "CustomRoot";
    xRoot.Namespace = "http://www.cpandl.com";
    xRoot.IsNullable = true;

    // Construct the XmlSerializer with the XmlRootAttribute.
    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem),xRoot);

    // Create an instance of the object to serialize.
    OrderedItem i = new OrderedItem();
    // Insert code to set properties of the ordered item.

    // Writing the document requires a TextWriter.
    TextWriter writer = new StreamWriter(filename);

    serializer.Serialize(writer, i);
    writer.Close();
}

private void DeserializeObject(string filename) {
    // Create an XmlRootAttribute, and set its properties.
    XmlRootAttribute xRoot = new XmlRootAttribute();
    xRoot.ElementName = "CustomRoot";
    xRoot.Namespace = "http://www.cpandl.com";
    xRoot.IsNullable = true;

    XmlSerializer serializer = new XmlSerializer
        (typeof(OrderedItem),xRoot);

    // A FileStream is needed to read the XML document.
    FileStream fs = new FileStream(filename, FileMode.Open);
    // Deserialize the object.
    OrderedItem i = (OrderedItem) serializer.Deserialize(fs);
    // Insert code to use the object's properties and methods.
}

Private Sub SerializeObject(ByVal filename As String)
    ' Create an XmlRootAttribute, and set its properties.
    Dim xRoot As New XmlRootAttribute()
    xRoot.ElementName = "CustomRoot"
    xRoot.Namespace = "http://www.cpandl.com"
    xRoot.IsNullable = True
    
    ' Construct the XmlSerializer with the XmlRootAttribute.
    Dim serializer As New XmlSerializer(GetType(OrderedItem), xRoot)
    
    ' Create an instance of the object to serialize.
    Dim i As New OrderedItem()
    ' Insert code to set properties of the ordered item.
    ' Writing the document requires a TextWriter.
    Dim writer As New StreamWriter(filename)
    
    serializer.Serialize(writer, i)
    writer.Close()
End Sub
    
Private Sub DeserializeObject(ByVal filename As String)
    ' Create an XmlRootAttribute, and set its properties.
    Dim xRoot As New XmlRootAttribute()
    xRoot.ElementName = "CustomRoot"
    xRoot.Namespace = "http://www.cpandl.com"
    xRoot.IsNullable = True
    
    Dim serializer As New XmlSerializer(GetType(OrderedItem), xRoot)
    
    ' A FileStream is needed to read the XML document.
    Dim fs As New FileStream(filename, FileMode.Open)
    ' Deserialize the object.
    Dim i As OrderedItem = CType(serializer.Deserialize(fs), OrderedItem)
    ' Insert code to use the object's properties and methods.
End Sub

Uwagi

Element główny dokumentu XML zawiera wszystkie pozostałe elementy. Domyślnie obiekt określony przez type parametr jest serializowany jako element główny. Właściwości, takie jak nazwa elementu XML elementu głównego, są pobierane z type obiektu. root Jednak parametr umożliwia zamianę informacji o obiekcie domyślnym, określając XmlRootAttributeobiekt ; obiekt umożliwia ustawienie innej przestrzeni nazw, nazwy elementu itd.

Zobacz też

• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty typu Object w wystąpieniach dokumentów XML i deserializować wystąpienia dokumentów XML do obiektów typu Object. Każdy obiekt, który ma być serializowany, może zawierać wystąpienia klas, które to przeciążenie przesłania z innymi klasami. To przeciążenie określa również domyślną przestrzeń nazw dla wszystkich elementów XML i klasy do użycia jako element główny XML.

public:
 XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides, cli::array <Type ^> ^ extraTypes, System::Xml::Serialization::XmlRootAttribute ^ root, System::String ^ defaultNamespace);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides? overrides, Type[]? extraTypes, System.Xml.Serialization.XmlRootAttribute? root, string? defaultNamespace);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides * Type[] * System.Xml.Serialization.XmlRootAttribute * string -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type, overrides As XmlAttributeOverrides, extraTypes As Type(), root As XmlRootAttribute, defaultNamespace As String)

Parametry

type

Type

Typ obiektu, który może serializować XmlSerializer .

overrides

XmlAttributeOverrides

Obiekt XmlAttributeOverrides , który rozszerza lub zastępuje zachowanie klasy określonej w parametrze type .

extraTypes

Type[]

Tablica Type dodatkowych typów obiektów do serializacji.

root

XmlRootAttribute

Element XmlRootAttribute definiujący właściwości elementu głównego XML.

defaultNamespace

String

Domyślna przestrzeń nazw wszystkich elementów XML w dokumencie XML.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute

Przykłady

Poniższy przykład serializuje wystąpienie klasy zdefiniowanej w dll i w tym celu zastępuje publiczne elementy członkowskie znalezione w klasie. W przykładzie określono również tablicę dodatkowych typów, domyślną przestrzeń nazw dla wszystkich elementów XML i klasę, która udostępnia informacje o elemecie głównym XML. W przykładzie przyjęto założenie, że kod na początku został skompilowany do biblioteki DLL o nazwie HighSchool.

// Beginning of the HighSchool.dll

namespace HighSchool
{
   public class Student
   {
      public string Name;
      public int ID;
   }

   public class MyClass
   {
      public Student[] Students;
   }
}

namespace College
   {
   using System;
   using System.IO;
   using System.Xml;
   using System.Xml.Serialization;
   using HighSchool;

    public class Graduate:HighSchool.Student
    {
       public Graduate(){}
       // Add a new field named University.
       public string University;
       // Use extra types to use this field.
       public object[]Info;
    }

    public class Address
    {
       public string City;
    }

    public class Phone
    {
       public string Number;
    }

   public class Run
   {
      public static void Main()
      {
         Run test = new Run();
         test.WriteOverriddenAttributes("College.xml");
         test.ReadOverriddenAttributes("College.xml");
      }

      private void WriteOverriddenAttributes(string filename)
      {
         // Writing the file requires a TextWriter.
         TextWriter myStreamWriter = new StreamWriter(filename);
         // Create an XMLAttributeOverrides class.
         XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
         // Create the XmlAttributes class.
         XmlAttributes attrs = new XmlAttributes();
         /* Override the Student class. "Alumni" is the name
         of the overriding element in the XML output. */

         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));
         /* Add the XmlElementAttribute to the collection of
         elements in the XmlAttributes object. */
         attrs.XmlElements.Add(attr);
         /* Add the XmlAttributes to the XmlAttributeOverrides.
         "Students" is the name being overridden. */
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         // Create array of extra types.
         Type [] extraTypes = new Type[2];
         extraTypes[0]=typeof(Address);
         extraTypes[1]=typeof(Phone);

         // Create an XmlRootAttribute.
         XmlRootAttribute root = new XmlRootAttribute("Graduates");

         /* Create the XmlSerializer with the
         XmlAttributeOverrides object. */
         XmlSerializer mySerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides, extraTypes,
         root, "http://www.microsoft.com");

         MyClass myClass= new MyClass();

         Graduate g1 = new Graduate();
         g1.Name = "Jacki";
         g1.ID = 1;
         g1.University = "Alma";

         Graduate g2 = new Graduate();
         g2.Name = "Megan";
         g2.ID = 2;
         g2.University = "CM";

         Student[] myArray = {g1,g2};

         myClass.Students = myArray;

         // Create extra information.
         Address a1 = new Address();
         a1.City = "Ionia";
         Address a2 = new Address();
         a2.City = "Stamford";
         Phone p1 = new Phone();
         p1.Number = "555-0101";
         Phone p2 = new Phone();
         p2.Number = "555-0100";

         Object[]o1 = new Object[2]{a1, p1};
         Object[]o2 = new Object[2]{a2,p2};

         g1.Info = o1;
         g2.Info = o2;
         mySerializer.Serialize(myStreamWriter,myClass);
         myStreamWriter.Close();
      }

      private void ReadOverriddenAttributes(string filename)
      {
         /* The majority of the code here is the same as that in the
         WriteOverriddenAttributes method. Because the XML being read
         doesn't conform to the schema defined by the DLL, the
         XMLAttributesOverrides must be used to create an
         XmlSerializer instance to read the XML document.*/

         XmlAttributeOverrides attrOverrides = new
         XmlAttributeOverrides();
         XmlAttributes attrs = new XmlAttributes();
         XmlElementAttribute attr =
         new XmlElementAttribute("Alumni", typeof(Graduate));
         attrs.XmlElements.Add(attr);
         attrOverrides.Add(typeof(HighSchool.MyClass),
         "Students", attrs);

         Type [] extraTypes = new Type[2];
         extraTypes[0] = typeof(Address);
         extraTypes[1] = typeof(Phone);

         XmlRootAttribute root = new XmlRootAttribute("Graduates");

         XmlSerializer readSerializer = new XmlSerializer
         (typeof(HighSchool.MyClass), attrOverrides, extraTypes,
         root, "http://www.microsoft.com");

         // A FileStream object is required to read the file.
         FileStream fs = new FileStream(filename, FileMode.Open);

         MyClass myClass;
         myClass = (MyClass) readSerializer.Deserialize(fs);

         /* Here is the difference between reading and writing an
         XML document: You must declare an object of the derived
         type (Graduate) and cast the Student instance to it.*/
         Graduate g;
         Address a;
         Phone p;
         foreach(Graduate grad in myClass.Students)
         {
            g = (Graduate) grad;
            Console.Write(g.Name + "\t");
            Console.Write(g.ID + "\t");
            Console.Write(g.University + "\n");
            a = (Address) g.Info[0];
            Console.WriteLine(a.City);
            p = (Phone) g.Info[1];
            Console.WriteLine(p.Number);
         }
      }
   }
}

'Beginning of the HighSchool.dll 
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization

' Imports HighSchool

Namespace HighSchool

    Public Class Student
        Public Name As String
        Public ID As Integer
    End Class


    Public Class ClassRoom
        Public Students() As Student
    End Class
End Namespace 'HighSchool

Namespace College
    Public Class Graduate
        Inherits HighSchool.Student

        Public Sub New()
        End Sub
        ' Add a new field named University.
        Public University As String
        ' Use extra types to use this field.
        Public Info() As Object
    End Class


    Public Class Address
        Public City As String
    End Class


    Public Class Phone
        Public Number As String
    End Class


    Public Class Run

        Public Shared Sub Main()
            Dim test As New Run()
            test.WriteOverriddenAttributes("College.xml")
            test.ReadOverriddenAttributes("College.xml")
        End Sub


        Private Sub WriteOverriddenAttributes(ByVal filename As String)
            ' Writing the file requires a TextWriter.
            Dim myStreamWriter As New StreamWriter(filename)
            ' Create an XMLAttributeOverrides class.
            Dim attrOverrides As New XmlAttributeOverrides()
            ' Create the XmlAttributes class.
            Dim attrs As New XmlAttributes()
            ' Override the Student class. "Alumni" is the name
            ' of the overriding element in the XML output. 

            Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
            ' Add the XmlElementAttribute to the collection of
            ' elements in the XmlAttributes object. 
            attrs.XmlElements.Add(attr)
            ' Add the XmlAttributes to the XmlAttributeOverrides.
            ' "Students" is the name being overridden. 
            attrOverrides.Add(GetType(HighSchool.ClassRoom), "Students", attrs)

            ' Create array of extra types.
            Dim extraTypes(1) As Type
            extraTypes(0) = GetType(Address)
            extraTypes(1) = GetType(Phone)

            ' Create an XmlRootAttribute.
            Dim root As New XmlRootAttribute("Graduates")

            ' Create the XmlSerializer with the
            ' XmlAttributeOverrides object. 
            Dim mySerializer As New XmlSerializer(GetType(HighSchool.ClassRoom), _
                attrOverrides, extraTypes, root, "http://www.microsoft.com")

            Dim oMyClass As New HighSchool.ClassRoom()

            Dim g1 As New Graduate()
            g1.Name = "Jacki"
            g1.ID = 1
            g1.University = "Alma"

            Dim g2 As New Graduate()
            g2.Name = "Megan"
            g2.ID = 2
            g2.University = "CM"

            Dim myArray As HighSchool.Student() = {g1, g2}

            oMyClass.Students = myArray

            ' Create extra information.
            Dim a1 As New Address()
            a1.City = "Ionia"
            Dim a2 As New Address()
            a2.City = "Stamford"
            Dim p1 As New Phone()
            p1.Number = "555-0101"
            Dim p2 As New Phone()
            p2.Number = "555-0100"

            Dim o1() As Object = {a1, p1}
            Dim o2() As Object = {a2, p2}

            g1.Info = o1
            g2.Info = o2
            mySerializer.Serialize(myStreamWriter, oMyClass)
            myStreamWriter.Close()
        End Sub


        Private Sub ReadOverriddenAttributes(ByVal filename As String)
            ' The majority of the code here is the same as that in the
            ' WriteOverriddenAttributes method. Because the XML being read
            ' doesn't conform to the schema defined by the DLL, the
            ' XMLAttributesOverrides must be used to create an
            ' XmlSerializer instance to read the XML document.

            Dim attrOverrides As New XmlAttributeOverrides()
            Dim attrs As New XmlAttributes()
            Dim attr As New XmlElementAttribute("Alumni", GetType(Graduate))
            attrs.XmlElements.Add(attr)
            attrOverrides.Add(GetType(HighSchool.ClassRoom), "Students", attrs)

            Dim extraTypes(1) As Type
            extraTypes(0) = GetType(Address)
            extraTypes(1) = GetType(Phone)

            Dim root As New XmlRootAttribute("Graduates")

            Dim readSerializer As New XmlSerializer(GetType(HighSchool.ClassRoom), _
                attrOverrides, extraTypes, root, "http://www.microsoft.com")

            ' A FileStream object is required to read the file. 
            Dim fs As New FileStream(filename, FileMode.Open)

            Dim oMyClass As HighSchool.ClassRoom
            oMyClass = CType(readSerializer.Deserialize(fs), HighSchool.ClassRoom)

            ' Here is the difference between reading and writing an
            ' XML document: You must declare an object of the derived
            ' type (Graduate) and cast the Student instance to it.
            Dim g As Graduate
            Dim a As Address
            Dim p As Phone
            Dim grad As Graduate
            For Each grad In oMyClass.Students
                g = CType(grad, Graduate)
                Console.Write((g.Name & ControlChars.Tab))
                Console.Write((g.ID & ControlChars.Tab))
                Console.Write((g.University & ControlChars.Cr))
                a = CType(g.Info(0), Address)
                Console.WriteLine(a.City)
                p = CType(g.Info(1), Phone)
                Console.WriteLine(p.Number)
            Next grad
        End Sub
    End Class
End Namespace 'College

Uwagi

Parametr overrides umożliwia utworzenie XmlSerializer klasy, która serializuje klasę, która rozszerza lub zastępuje zachowanie klasy bazowej. Na przykład, biorąc pod uwagę bibliotekę DLL, można utworzyć klasę, która dziedziczy lub rozszerza klasę zawartą w dll. Aby serializować taką klasę, należy użyć wystąpienia XmlAttributeOverrides klasy podczas konstruowania XmlSerializerklasy . Aby uzyskać więcej informacji, zobacz XmlAttributeOverrides.

Domyślnie, jeśli właściwość publiczna lub pole zwraca obiekt lub tablicę obiektów, typy obiektów są automatycznie serializowane. Jeśli jednak klasa zawiera pole lub właściwość zwracającą tablicę typu Object, do tej tablicy można wstawić dowolny obiekt. W takim przypadku należy poinstruować, XmlSerializer aby oczekiwać wszystkich możliwych typów obiektów wstawionych do tablicy Object . W tym celu użyj parametru extraTypes , aby określić dodatkowe typy obiektów do serializacji lub deserializacji.

Element główny dokumentu XML zawiera wszystkie pozostałe elementy. Domyślnie obiekt określony przez type parametr jest serializowany jako element główny. Właściwości, takie jak nazwa elementu XML elementu głównego, są pobierane z type obiektu. root Jednak parametr umożliwia zamianę informacji o obiekcie domyślnym, określając XmlRootAttributeobiekt ; obiekt umożliwia ustawienie innej przestrzeni nazw, nazwy elementu itd.

Użyj parametru , defaultName aby określić domyślną przestrzeń nazw wszystkich elementów XML wygenerowanych przez element XmlSerializer.

Zobacz też

• XmlAttributeOverrides
• XmlRootAttribute
• XmlAttributes
• Wprowadzenie do serializacji XML
• Instrukcje: określanie alternatywnej nazwy elementu dla strumienia XML
• Kontrolowanie serializacji XML przy użyciu atrybutów
• Przykłady serializacji XML
• Narzędzie definicji schematu XML (Xsd.exe)

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)

Źródło:

XmlSerializer.cs

Inicjuje nowe wystąpienie XmlSerializer klasy, które może serializować obiekty typu Object w wystąpieniach dokumentów XML i deserializować wystąpienia dokumentów XML do obiektów typu Object. Każdy obiekt, który ma być serializowany, może zawierać wystąpienia klas, które to przeciążenie przesłania z innymi klasami. To przeciążenie określa również domyślną przestrzeń nazw dla wszystkich elementów XML i klasy do użycia jako element główny XML.

public:
 XmlSerializer(Type ^ type, System::Xml::Serialization::XmlAttributeOverrides ^ overrides, cli::array <Type ^> ^ extraTypes, System::Xml::Serialization::XmlRootAttribute ^ root, System::String ^ defaultNamespace, System::String ^ location);

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")]
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")]
public XmlSerializer(Type type, System.Xml.Serialization.XmlAttributeOverrides? overrides, Type[]? extraTypes, System.Xml.Serialization.XmlRootAttribute? root, string? defaultNamespace, string? location);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("XML serializer relies on dynamic code generation which is not available with Ahead of Time compilation")>]
[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Members from serialized types may be trimmed if not referenced directly")>]
new System.Xml.Serialization.XmlSerializer : Type * System.Xml.Serialization.XmlAttributeOverrides * Type[] * System.Xml.Serialization.XmlRootAttribute * string * string -> System.Xml.Serialization.XmlSerializer

Public Sub New (type As Type, overrides As XmlAttributeOverrides, extraTypes As Type(), root As XmlRootAttribute, defaultNamespace As String, location As String)

Parametry

type

Type

Typ obiektu, który może serializować XmlSerializer .

overrides

XmlAttributeOverrides

Obiekt XmlAttributeOverrides , który rozszerza lub zastępuje zachowanie klasy określonej w parametrze type .

extraTypes

Type[]

Tablica Type dodatkowych typów obiektów do serializacji.

root

XmlRootAttribute

Element XmlRootAttribute definiujący właściwości elementu głównego XML.

defaultNamespace

String

Domyślna przestrzeń nazw wszystkich elementów XML w dokumencie XML.

location

String

Lokalizacja typów.

Atrybuty

RequiresDynamicCodeAttribute RequiresUnreferencedCodeAttribute