XmlSerializer Osztály

Definíció

Névtér:

System.Xml.Serialization

Szerelvények:

netstandard.dll, System.Xml.XmlSerializer.dll

Forrás:

XmlSerializer.cs

Szerializálja és deszerializálja az objektumokat XML-dokumentumokba és azokból. Ez XmlSerializer lehetővé teszi az objektumok XML-kódolásának szabályozását.

public ref class XmlSerializer

public class XmlSerializer

type XmlSerializer = class

Public Class XmlSerializer

Öröklődés

Object

XmlSerializer

Példák

Az alábbi példa két fő osztályt tartalmaz: PurchaseOrder és Test. Az PurchaseOrder osztály egyetlen vásárlással kapcsolatos információkat tartalmaz. Az Test osztály tartalmazza a beszerzési rendelést létrehozó metódusokat, és beolvassa a létrehozott beszerzési rendelést.

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

/* The XmlRootAttribute allows you to set an alternate name
   (PurchaseOrder) of the XML element, the element namespace; by
   default, the XmlSerializer uses the class name. The attribute
   also allows you to set the XML namespace for the element.  Lastly,
   the attribute sets the IsNullable property, which specifies whether
   the xsi:null attribute appears if the class instance is set to
   a null reference. */
[XmlRootAttribute("PurchaseOrder", Namespace="http://www.cpandl.com",
IsNullable = false)]
public class PurchaseOrder
{
   public Address ShipTo;
   public string OrderDate;
   /* The XmlArrayAttribute changes the XML element name
    from the default of "OrderedItems" to "Items". */
   [XmlArrayAttribute("Items")]
   public OrderedItem[] OrderedItems;
   public decimal SubTotal;
   public decimal ShipCost;
   public decimal TotalCost;
}

public class Address
{
   /* The XmlAttribute instructs the XmlSerializer to serialize the Name
      field as an XML attribute instead of an XML element (the default
      behavior). */
   [XmlAttribute]
   public string Name;
   public string Line1;

   /* Setting the IsNullable property to false instructs the
      XmlSerializer that the XML attribute will not appear if
      the City field is set to a null reference. */
   [XmlElementAttribute(IsNullable = false)]
   public string City;
   public string State;
   public string Zip;
}

public class OrderedItem
{
   public string ItemName;
   public string Description;
   public decimal UnitPrice;
   public int Quantity;
   public decimal LineTotal;

   /* Calculate is a custom method that calculates the price per item,
      and stores the value in a field. */
   public void Calculate()
   {
      LineTotal = UnitPrice * Quantity;
   }
}

public class Test
{
   public static void Main()
   {
      // Read and write purchase orders.
      Test t = new Test();
      t.CreatePO("po.xml");
      t.ReadPO("po.xml");
   }

   private void CreatePO(string filename)
   {
      // Create an instance of the XmlSerializer class;
      // specify the type of object to serialize.
      XmlSerializer serializer =
      new XmlSerializer(typeof(PurchaseOrder));
      TextWriter writer = new StreamWriter(filename);
      PurchaseOrder po=new PurchaseOrder();

      // Create an address to ship and bill to.
      Address billAddress = new Address();
      billAddress.Name = "Teresa Atkinson";
      billAddress.Line1 = "1 Main St.";
      billAddress.City = "AnyTown";
      billAddress.State = "WA";
      billAddress.Zip = "00000";
      // Set ShipTo and BillTo to the same addressee.
      po.ShipTo = billAddress;
      po.OrderDate = System.DateTime.Now.ToLongDateString();

      // Create an OrderedItem object.
      OrderedItem i1 = new OrderedItem();
      i1.ItemName = "Widget S";
      i1.Description = "Small widget";
      i1.UnitPrice = (decimal) 5.23;
      i1.Quantity = 3;
      i1.Calculate();

      // Insert the item into the array.
      OrderedItem [] items = {i1};
      po.OrderedItems = items;
      // Calculate the total cost.
      decimal subTotal = new decimal();
      foreach(OrderedItem oi in items)
      {
         subTotal += oi.LineTotal;
      }
      po.SubTotal = subTotal;
      po.ShipCost = (decimal) 12.51;
      po.TotalCost = po.SubTotal + po.ShipCost;
      // Serialize the purchase order, and close the TextWriter.
      serializer.Serialize(writer, po);
      writer.Close();
   }

   protected void ReadPO(string filename)
   {
      // Create an instance of the XmlSerializer class;
      // specify the type of object to be deserialized.
      XmlSerializer serializer = new XmlSerializer(typeof(PurchaseOrder));
      /* If the XML document has been altered with unknown
      nodes or attributes, handle them with the
      UnknownNode and UnknownAttribute events.*/
      serializer.UnknownNode+= new
      XmlNodeEventHandler(serializer_UnknownNode);
      serializer.UnknownAttribute+= new
      XmlAttributeEventHandler(serializer_UnknownAttribute);

      // 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.
      PurchaseOrder po;
      /* Use the Deserialize method to restore the object's state with
      data from the XML document. */
      po = (PurchaseOrder) serializer.Deserialize(fs);
      // Read the order date.
      Console.WriteLine ("OrderDate: " + po.OrderDate);

      // Read the shipping address.
      Address shipTo = po.ShipTo;
      ReadAddress(shipTo, "Ship To:");
      // Read the list of ordered items.
      OrderedItem [] items = po.OrderedItems;
      Console.WriteLine("Items to be shipped:");
      foreach(OrderedItem oi in items)
      {
         Console.WriteLine("\t"+
         oi.ItemName + "\t" +
         oi.Description + "\t" +
         oi.UnitPrice + "\t" +
         oi.Quantity + "\t" +
         oi.LineTotal);
      }
      // Read the subtotal, shipping cost, and total cost.
      Console.WriteLine("\t\t\t\t\t Subtotal\t" + po.SubTotal);
      Console.WriteLine("\t\t\t\t\t Shipping\t" + po.ShipCost);
      Console.WriteLine("\t\t\t\t\t Total\t\t" + po.TotalCost);
   }

   protected void ReadAddress(Address a, string label)
   {
      // Read the fields of the Address object.
      Console.WriteLine(label);
      Console.WriteLine("\t"+ a.Name );
      Console.WriteLine("\t" + a.Line1);
      Console.WriteLine("\t" + a.City);
      Console.WriteLine("\t" + a.State);
      Console.WriteLine("\t" + a.Zip );
      Console.WriteLine();
   }

   private void serializer_UnknownNode
   (object sender, XmlNodeEventArgs e)
   {
      Console.WriteLine("Unknown Node:" +   e.Name + "\t" + e.Text);
   }

   private void serializer_UnknownAttribute
   (object sender, XmlAttributeEventArgs e)
   {
      System.Xml.XmlAttribute attr = e.Attr;
      Console.WriteLine("Unknown attribute " +
      attr.Name + "='" + attr.Value + "'");
   }
}

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

' The XmlRootAttribute allows you to set an alternate name
' (PurchaseOrder) of the XML element, the element namespace; by
' default, the XmlSerializer uses the class name. The attribute
' also allows you to set the XML namespace for the element.  Lastly,
' the attribute sets the IsNullable property, which specifies whether
' the xsi:null attribute appears if the class instance is set to
' a null reference. 
<XmlRootAttribute("PurchaseOrder", _
 Namespace := "http://www.cpandl.com", IsNullable := False)> _
Public Class PurchaseOrder
    
    Public ShipTo As Address
    Public OrderDate As String
    ' The XmlArrayAttribute changes the XML element name
    ' from the default of "OrderedItems" to "Items". 
    <XmlArrayAttribute("Items")> _
    Public OrderedItems() As OrderedItem
    Public SubTotal As Decimal
    Public ShipCost As Decimal
    Public TotalCost As Decimal
End Class


Public Class Address
    ' The XmlAttribute instructs the XmlSerializer to serialize the Name
    ' field as an XML attribute instead of an XML element (the default
    ' behavior). 
    <XmlAttribute()> _
    Public Name As String
    Public Line1 As String
    
    ' Setting the IsNullable property to false instructs the
    ' XmlSerializer that the XML attribute will not appear if
    ' the City field is set to a null reference. 
    <XmlElementAttribute(IsNullable := False)> _
    Public City As String
    Public State As String
    Public Zip As String
End Class


Public Class OrderedItem
    Public ItemName As String
    Public Description As String
    Public UnitPrice As Decimal
    Public Quantity As Integer
    Public LineTotal As Decimal
    
    
    ' Calculate is a custom method that calculates the price per item,
    ' and stores the value in a field. 
    Public Sub Calculate()
        LineTotal = UnitPrice * Quantity
    End Sub
End Class


Public Class Test
    
   Public Shared Sub Main()
      ' Read and write purchase orders.
      Dim t As New Test()
      t.CreatePO("po.xml")
      t.ReadPO("po.xml")
   End Sub
    
   Private Sub CreatePO(filename As String)
      ' Create an instance of the XmlSerializer class;
      ' specify the type of object to serialize.
      Dim serializer As New XmlSerializer(GetType(PurchaseOrder))
      Dim writer As New StreamWriter(filename)
      Dim po As New PurchaseOrder()
        
      ' Create an address to ship and bill to.
      Dim billAddress As New Address()
      billAddress.Name = "Teresa Atkinson"
      billAddress.Line1 = "1 Main St."
      billAddress.City = "AnyTown"
      billAddress.State = "WA"
      billAddress.Zip = "00000"
      ' Set ShipTo and BillTo to the same addressee.
      po.ShipTo = billAddress
      po.OrderDate = System.DateTime.Now.ToLongDateString()
        
      ' Create an OrderedItem object.
      Dim i1 As New OrderedItem()
      i1.ItemName = "Widget S"
      i1.Description = "Small widget"
      i1.UnitPrice = CDec(5.23)
      i1.Quantity = 3
      i1.Calculate()
        
      ' Insert the item into the array.
      Dim items(0) As OrderedItem
      items(0) = i1
      po.OrderedItems = items
      ' Calculate the total cost.
      Dim subTotal As New Decimal()
      Dim oi As OrderedItem
      For Each oi In  items
         subTotal += oi.LineTotal
      Next oi
      po.SubTotal = subTotal
      po.ShipCost = CDec(12.51)
      po.TotalCost = po.SubTotal + po.ShipCost
      ' Serialize the purchase order, and close the TextWriter.
      serializer.Serialize(writer, po)
      writer.Close()
   End Sub
    
   Protected Sub ReadPO(filename As String)
      ' Create an instance of the XmlSerializer class;
      ' specify the type of object to be deserialized.
      Dim serializer As New XmlSerializer(GetType(PurchaseOrder))
      ' If the XML document has been altered with unknown
      ' nodes or attributes, handle them with the
      ' UnknownNode and UnknownAttribute events.
      AddHandler serializer.UnknownNode, AddressOf serializer_UnknownNode
      AddHandler serializer.UnknownAttribute, AddressOf serializer_UnknownAttribute
      
      ' 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 po As PurchaseOrder
      ' Use the Deserialize method to restore the object's state with
      ' data from the XML document. 
      po = CType(serializer.Deserialize(fs), PurchaseOrder)
      ' Read the order date.
      Console.WriteLine(("OrderDate: " & po.OrderDate))
        
      ' Read the shipping address.
      Dim shipTo As Address = po.ShipTo
      ReadAddress(shipTo, "Ship To:")
      ' Read the list of ordered items.
      Dim items As OrderedItem() = po.OrderedItems
      Console.WriteLine("Items to be shipped:")
      Dim oi As OrderedItem
      For Each oi In  items
         Console.WriteLine((ControlChars.Tab & oi.ItemName & ControlChars.Tab & _
         oi.Description & ControlChars.Tab & oi.UnitPrice & ControlChars.Tab & _
         oi.Quantity & ControlChars.Tab & oi.LineTotal))
      Next oi
      ' Read the subtotal, shipping cost, and total cost.
      Console.WriteLine(( New String(ControlChars.Tab, 5) & _
      " Subtotal"  & ControlChars.Tab & po.SubTotal))
      Console.WriteLine(New String(ControlChars.Tab, 5) & _
      " Shipping" & ControlChars.Tab & po.ShipCost )
      Console.WriteLine( New String(ControlChars.Tab, 5) & _
      " Total" &  New String(ControlChars.Tab, 2) & po.TotalCost)
    End Sub
    
    Protected Sub ReadAddress(a As Address, label As String)
      ' Read the fields of the Address object.
      Console.WriteLine(label)
      Console.WriteLine(ControlChars.Tab & a.Name)
      Console.WriteLine(ControlChars.Tab & a.Line1)
      Console.WriteLine(ControlChars.Tab & a.City)
      Console.WriteLine(ControlChars.Tab & a.State)
      Console.WriteLine(ControlChars.Tab & a.Zip)
      Console.WriteLine()
    End Sub
        
    Private Sub serializer_UnknownNode(sender As Object, e As XmlNodeEventArgs)
        Console.WriteLine(("Unknown Node:" & e.Name & ControlChars.Tab & e.Text))
    End Sub
    
    
    Private Sub serializer_UnknownAttribute(sender As Object, e As XmlAttributeEventArgs)
        Dim attr As System.Xml.XmlAttribute = e.Attr
        Console.WriteLine(("Unknown attribute " & attr.Name & "='" & attr.Value & "'"))
    End Sub
End Class

Megjegyzések

Az XML-szerializálás az objektum nyilvános tulajdonságainak és mezőinek soros formátumba (ebben az esetben XML) történő konvertálása tárolás vagy átvitel céljából. A deszerializálás újra létrehozza az objektumot az eredeti állapotában az XML-kimenetből. A szerializálás az objektumok állapotának streambe vagy pufferbe való mentésének módjaként is felfogható. Például ASP.NET az osztály használatával kódolja az XmlSerializer XML webszolgáltatás-üzeneteket.

Az objektumok adatainak leírása programozási nyelv szerkezetekkel történik, például osztályok, mezők, tulajdonságok, primitív típusok, tömbök és akár beágyazott XML-fájlok formájában vagy XmlElement objektumok formájábanXmlAttribute. Lehetősége van saját osztályokat létrehozni, attribútumokkal jegyzetekkel ellátni, vagy az XML sémadefiníciós eszközzel (Xsd.exe) létrehozni az osztályokat egy meglévő XML-sémadefiníciós (XSD) dokumentum alapján. Ha XML-sémával rendelkezik, a Xsd.exe futtatásával egy osztálykészletet hozhat létre, amely erősen típusosan a sémához kötődnek, és attribútumokkal vannak ellátva, hogy a sémához igazodjanak a szerializálás során.

Az adatok objektumok és XML közötti átviteléhez a programozási nyelv szerkezetéből az XML-sémába, valamint az XML-sémából a programozási nyelvi szerkezetekbe való leképezésre van szükség. Az XmlSerializer olyan kapcsolódó eszközök, mint a Xsd.exe biztosítják a hidat a két technológia között mind a tervezési időben, mind a futtatókörnyezetben. Tervezéskor használja a Xsd.exe-t a saját osztályaiból egy XML séma dokumentum (.xsd) előállításához vagy osztályok előállításához egy adott sémából. Az osztályok mindkét esetben egyéni attribútumokkal vannak eljegyzve, hogy a rendszer útmutatást adjon az XmlSerializer XML-sémarendszer és a közös nyelvi futtatókörnyezet közötti megfeleltetésről. Futásidőben az osztályok példányai szerializálhatók az adott sémát követő XML-dokumentumokba. Hasonlóképpen, ezek az XML-dokumentumok futtatókörnyezeti objektumokká deszerializálhatók. Vegye figyelembe, hogy az XML-séma nem kötelező, és nem szükséges a tervezéskor vagy a futtatókörnyezetben.

A generált XML vezérlése

A létrehozott XML szabályozásához speciális attribútumokat alkalmazhat az osztályokra és a tagokra. Ha például egy másik XML-elemnevet szeretne megadni, alkalmazzon egy XmlElementAttribute nyilvános mezőt vagy tulajdonságot, és állítsa be a tulajdonságot ElementName . A hasonló attribútumok teljes listáját az XML-szerializálást vezérlő attribútumok című témakörben találja. Az XML-kimenet szabályozásához implementálhatja az IXmlSerializable interfészt is.

Ha a létrehozott XML-fájlnak meg kell felelnie a World Wide Consortium dokumentum 5. szakaszának, Simple Object Access Protocol (SOAP) 1.1, meg kell építenie a(z) XmlSerializer egy XmlTypeMapping-vel. A kódolt SOAP XML további szabályozásához használja a kódolt SOAP szerializálást vezérlő attribútumokban felsorolt attribútumokat.

Az XmlSerializer segítségével kihasználhatja az erősen típusozott osztályok előnyeit, miközben megőrzi az XML használatának rugalmasságát. Az erősen típusos osztályaiban a XmlElement, XmlAttribute vagy XmlNode típusú mezők vagy tulajdonságok használatával közvetlenül XML-objektumokba olvashatja be az XML-dokumentum részeit.

Ha bővíthető XML-sémákkal dolgozik, akkor az XmlAnyElementAttribute és XmlAnyAttributeAttribute attribútumokat is használhatja olyan elemek vagy attribútumok szerializálására és deszerializálására, amelyek nem találhatók az eredeti sémában. Az objektumok használatához alkalmazzon egy XmlAnyElementAttribute olyan mezőt, amely egy objektumtömböt XmlElement ad vissza, vagy alkalmazzon egy XmlAnyAttributeAttribute olyan mezőre, amely egy objektumtömböt XmlAttribute ad vissza.

Ha egy tulajdonság vagy mező összetett objektumot (például tömböt vagy osztálypéldányt) ad vissza, az XmlSerializer átalakítja azt a fő XML-dokumentumban beágyazott elemgé. Az alábbi kód első osztálya például a második osztály egy példányát adja vissza.

Public Class MyClass
    Public MyObjectProperty As MyObject
End Class

Public Class MyObject
    Public ObjectName As String
End Class

public class MyClass
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

A szerializált, XML-kimenet így néz ki:

<MyClass>
  <MyObjectProperty>
  <ObjectName>My String</ObjectName>
  </MyObjectProperty>
</MyClass>

Ha egy séma nem kötelező elemet tartalmaz (minOccurs = '0'), vagy ha a séma alapértelmezett értéket tartalmaz, két lehetőség közül választhat. Az egyik lehetőség az System.ComponentModel.DefaultValueAttribute alapértelmezett érték megadása az alábbi kódban látható módon.

Public Class PurchaseOrder
    <System.ComponentModel.DefaultValueAttribute ("2002")> _
    Public Year As String
End Class

public class PurchaseOrder
{
    [System.ComponentModel.DefaultValueAttribute ("2002")]
    public string Year;
}

Egy másik lehetőség, hogy egy speciális mintát használ a XmlSerializer által felismerhető logikai mező létrehozásához, és a XmlIgnoreAttribute alkalmazását a mezőre. A minta a következő formában propertyNameSpecifiedjön létre: . Ha például van egy "MyFirstName" nevű mező, akkor egy "MyFirstNameSpecified" nevű mezőt is létre kell hoznia, amely arra utasítja, XmlSerializer hogy létre kell-e hozni a "MyFirstName" nevű XML-elemet. Ez az alábbi példában látható.

Public Class OptionalOrder
    ' This field's value should not be serialized
    ' if it is uninitialized.
    Public FirstOrder As String

    ' Use the XmlIgnoreAttribute to ignore the
    ' special field named "FirstOrderSpecified".
    <System.Xml.Serialization.XmlIgnoreAttribute> _
    Public FirstOrderSpecified As Boolean
End Class

public class OptionalOrder
{
    // This field should not be serialized
    // if it is uninitialized.
    public string FirstOrder;

    // Use the XmlIgnoreAttribute to ignore the
    // special field named "FirstOrderSpecified".
    [System.Xml.Serialization.XmlIgnoreAttribute]
    public bool FirstOrderSpecified;
}

Az alapértelmezett szerializálás felülbírálása

Felülbírálhatja az objektumok és azok mezőinek és tulajdonságainak szerializálását is, ha létrehoz egy megfelelő attribútumot, és hozzáadja azt az XmlAttributes osztály egy példányához. A szerializálás felülírásának két felhasználási módja van: először is szabályozhatja és kiegészítheti a DLL-ben található objektumok szerializálását, még akkor is, ha nincs hozzáférése a forráshoz; másodszor létrehozhat egy sor szerializálható osztályt, de többféleképpen szerializálhatja az objektumokat. További részletekért lásd a XmlAttributeOverrides osztályt és a Hogyan: A származtatott osztályok szerializálásának szabályozása című részben.

Objektum szerializálásához hívja meg a metódust Serialize . Egy objektum deszerializálásához hívja meg a metódust Deserialize .

Ha XML-névtereket szeretne hozzáadni egy XML-dokumentumhoz, tekintse meg a következőt XmlSerializerNamespaces:

Note

A XmlSerializer különleges bánásmódban részesíti azokat az osztályokat, amelyek implementálják a IEnumerable vagy ICollection-t. A implementálandó osztálynak IEnumerable olyan nyilvános Add metódust kell implementálnia, amely egyetlen paramétert használ. A Add metódus paraméterének ugyanolyan típusúnak kell lennie, mint amit a Current tulajdonság ad vissza a GetEnumerator által visszaadott értéken, vagy annak a típusnak az alapjainak egyikéről. Egy osztálynak, amely megvalósítja a ICollection-t és a CollectionBase-t (mint például a IEnumerable), rendelkeznie kell egy nyilvános Item indexelt tulajdonsággal (C#-ban indexelővel), amely egy egész számot vesz igénybe, és rendelkeznie kell egy nyilvános egész típusú Count tulajdonsággal. A metódus paraméterének Add meg kell egyeznie a tulajdonságból Item visszaadott típussal, vagy az adott típus alapjainak egyikével. A implementálandó ICollectionosztályok esetében a szerializálandó értékek az indexelt Item tulajdonságból lesznek lekérve, nem meghívással GetEnumerator.

Az objektum deszerializálásához engedéllyel kell rendelkeznie ahhoz, hogy az ideiglenes könyvtárba (a TEMP környezeti változó által meghatározott módon) írjon.

Dinamikusan létrehozott szerelvények

A teljesítmény növelése érdekében az XML szerializálási infrastruktúra dinamikusan generál szerelvényeket a megadott típusok szerializálásához és deszerializálásához. Az infrastruktúra megkeresi és újra felhasználja ezeket az összeállításokat. Ez a viselkedés csak a következő konstruktorok használatakor fordul elő:

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

Ha a többi konstruktort használja, ugyanannak a szerelvénynek több verziója is létrejön, és soha nem lesz eltávolítva, ami memóriavesztést és gyenge teljesítményt eredményez. A legegyszerűbb megoldás a korábban említett két konstruktor egyikének használata. Ellenkező esetben az alábbi példában bemutatott módon cache-elnie kell a szerelvényeket egy Hashtable.

Hashtable serializers = new Hashtable();

// Use the constructor that takes a type and XmlRootAttribute.
XmlSerializer s = new XmlSerializer(typeof(MyClass), myRoot);

// Implement a method named GenerateKey that creates unique keys
// for each instance of the XmlSerializer. The code should take
// into account all parameters passed to the XmlSerializer
// constructor.
object key = GenerateKey(typeof(MyClass), myRoot);

// Check the local cache for a matching serializer.
XmlSerializer ser = (XmlSerializer)serializers[key];
if (ser == null)
{
    ser = new XmlSerializer(typeof(MyClass), myRoot);
    // Cache the serializer.
    serializers[key] = ser;
}

// Use the serializer to serialize or deserialize.

Dim serializers As New Hashtable()

' Use the constructor that takes a type and XmlRootAttribute.
Dim s As New XmlSerializer(GetType([MyClass]), myRoot)

' Implement a method named GenerateKey that creates unique keys
' for each instance of the XmlSerializer. The code should take
' into account all parameters passed to the XmlSerializer
' constructor.
Dim key As Object = GenerateKey(GetType([MyClass]), myRoot)

' Check the local cache for a matching serializer.
Dim ser As XmlSerializer = CType(serializers(key), XmlSerializer)

If ser Is Nothing Then
    ser = New XmlSerializer(GetType([MyClass]), myRoot)
    ' Cache the serializer.
    serializers(key) = ser
End If

' Use the serializer to serialize or deserialize.

Tömblista és általános lista szerializálása

A következő elemek nem szerializálhatók vagy deszerializálhatók: XmlSerializer

• Tömbök ArrayList
• Tömbök List<T>

Előjel nélküli Long típusú enumerációk szerializálása

A XmlSerializer nem példányosítható sorosításhoz, ha a következő feltételek teljesülnek: Az enumeráció nem előjeles hosszú egész típusú (ulong a C#-ban), és az enumeráció tartalmaz olyan tagot, amelynek értéke meghaladja a 9 223 372 036 854 775 807-et. Az alábbiak például nem szerializálhatók.

public enum LargeNumbers: ulong
{
    a = 9223372036854775808
}
// At runtime, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));

Elavult típusok

Az XmlSerializer osztály nem szerializálja a megjelölt [Obsolete]objektumokat.

Konstruktorok

Name	Description
XmlSerializer()	Inicializálja a XmlSerializer osztály új példányát.
XmlSerializer(Type, String)	Inicializálja az XmlSerializer osztály új példányát, amely a megadott típusú objektumokat XML-dokumentumokká szerializálhatja, és deszerializálja az XML-dokumentumokat a megadott típusú objektumokká. Az összes XML-elem alapértelmezett névterét adja meg.
XmlSerializer(Type, Type[])	Inicializálja az XmlSerializer osztály új példányát, amely képes a megadott típusú objektumok XML-dokumentumokká való szerializálására, és az XML-dokumentumok deszerializálására egy adott típusú objektumba. Ha egy tulajdonság vagy mező tömböt ad vissza, a extraTypes paraméter olyan objektumokat határoz meg, amelyeket be lehet szúrni a tömbbe.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)	Inicializálja az osztály új példányát, amely xml-dokumentumpéldányokká szerializálja a XmlSerializer típusobjektumokat Object , és deszerializálja az XML-dokumentumpéldányokat típusobjektumokká Object. Minden szerializálandó objektum tartalmazhat osztálypéldányokat, amelyeket ez a túlterhelés felülír más osztályokkal. Ez a túlterhelés az összes XML-elem alapértelmezett névterét és az XML-gyökérelemként használni kívánt osztályt is meghatározza.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)	Inicializálja az osztály új példányát, amely xml-dokumentumpéldányokká szerializálja a XmlSerializer típusobjektumokat Object , és deszerializálja az XML-dokumentumpéldányokat típusobjektumokká Object. Minden szerializálandó objektum tartalmazhat osztálypéldányokat, amelyeket ez a túlterhelés felülír más osztályokkal. Ez a túlterhelés az összes XML-elem alapértelmezett névterét és az XML-gyökérelemként használni kívánt osztályt is meghatározza.
XmlSerializer(Type, XmlAttributeOverrides)	Inicializálja az XmlSerializer osztály új példányát, amely a megadott típusú objektumokat XML-dokumentumokká szerializálhatja, és deszerializálja az XML-dokumentumokat a megadott típusú objektumokká. Minden szerializálandó objektum tartalmazhat osztálypéldányokat, amelyeket ez a túlterhelés felülbírálhat más osztályokkal.
XmlSerializer(Type, XmlRootAttribute)	Inicializálja az XmlSerializer osztály új példányát, amely képes a megadott típusú objektumokat XML-dokumentumokká szerializálni, és deszerializálni egy XML-dokumentumot a megadott típusú objektummá. Emellett megadja az XML-gyökérelemként használni kívánt osztályt is.
XmlSerializer(Type)	Inicializálja az XmlSerializer osztály új példányát, amely a megadott típusú objektumokat XML-dokumentumokká szerializálhatja, és deszerializálja az XML-dokumentumokat a megadott típusú objektumokká.
XmlSerializer(XmlTypeMapping)	Inicializálja az XmlSerializer osztály egy példányát egy olyan objektummal, amely leképezi az egyik típust egy másikra.

Metódusok

Name	Description
CanDeserialize(XmlReader)	Olyan értéket kap, amely jelzi, hogy ez XmlSerializer képes-e deszerializálni egy adott XML-dokumentumot.
CreateReader()	A szerializálandó XML-dokumentum olvasásához használt objektumot ad vissza.
CreateWriter()	Ha felül van bírálva egy származtatott osztályban, az objektum szerializálásához használt írót ad vissza.
Deserialize(Stream)	Deszerializálja a megadott StreamXML-dokumentumot.
Deserialize(TextReader)	Deszerializálja a megadott TextReaderXML-dokumentumot.
Deserialize(XmlReader, String, XmlDeserializationEvents)	Deszerializálja az objektumot a megadott XmlReaderadatok használatával.
Deserialize(XmlReader, String)	Deszerializálja a megadott XmlReader és kódolási stílus által tartalmazott XML-dokumentumot.
Deserialize(XmlReader, XmlDeserializationEvents)	Deszerializálja a megadott XmlReader XML-dokumentumot, és lehetővé teszi a deszerializálás során előforduló események felülírását.
Deserialize(XmlReader)	Deszerializálja a megadott XmlReaderXML-dokumentumot.
Deserialize(XmlSerializationReader)	Deszerializálja a megadott XmlSerializationReaderXML-dokumentumot.
Equals(Object)	Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal. (Öröklődés forrása Object)
FromMappings(XmlMapping[], Type)	Az osztály egy példányát XmlSerializer adja vissza a megadott leképezésekből.
FromMappings(XmlMapping[])	Objektumtömbből XmlSerializer létrehozott objektumtömböt XmlTypeMapping ad vissza.
FromTypes(Type[])	Egy típustömbből létrehozott objektumtömböt XmlSerializer ad vissza.
GetHashCode()	Ez az alapértelmezett kivonatoló függvény. (Öröklődés forrása Object)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
GetXmlSerializerAssemblyName(Type, String)	A megadott névtérben megadott típus szerializálóját tartalmazó szerelvény nevét adja vissza.
GetXmlSerializerAssemblyName(Type)	A kifejezetten a megadott típus szerializálásához vagy deszerializálásához létrehozott egy vagy több verzióját XmlSerializer tartalmazó szerelvény nevét adja vissza.
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
Serialize(Object, XmlSerializationWriter)	Szerializálja a megadott Object fájlt, és a megadott XmlSerializationWriterfájlba írja az XML-dokumentumot.
Serialize(Stream, Object, XmlSerializerNamespaces)	Szerializálja a megadott Object fájlt, és a megadott Stream névterekre hivatkozó fájlba írja az XML-dokumentumot.
Serialize(Stream, Object)	Szerializálja a megadott Object fájlt, és a megadott Streamfájlba írja az XML-dokumentumot.
Serialize(TextWriter, Object, XmlSerializerNamespaces)	Szerializálja a megadott Object fájlt, és a megadott TextWriter névterekre hivatkozva egy fájlba írja az XML-dokumentumot.
Serialize(TextWriter, Object)	Szerializálja a megadott Object fájlt, és a megadott TextWriterfájlba írja az XML-dokumentumot.
Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String)	Szerializálja a megadott Object fájlt, és egy fájlba írja az XML-dokumentumot a megadott XmlWriterXML-névterek és kódolás használatával.
Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)	Szerializálja a megadott objektumot, és a megadott XmlWriter névterekre és kódolási stílusra hivatkozva egy fájlba írja az XML-dokumentumot.
Serialize(XmlWriter, Object, XmlSerializerNamespaces)	Szerializálja a megadott Object fájlt, és a megadott XmlWriter névterekre hivatkozva egy fájlba írja az XML-dokumentumot.
Serialize(XmlWriter, Object)	Szerializálja a megadott Object fájlt, és a megadott XmlWriterfájlba írja az XML-dokumentumot.
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

esemény

Name	Description
UnknownAttribute	Akkor fordul elő, ha a deszerializálás során ismeretlen XmlSerializer típusú XML-attribútummal találkozik.
UnknownElement	Akkor fordul elő, ha a deszerializálás során ismeretlen XmlSerializer típusú XML-elem jelenik meg.
UnknownNode	Akkor fordul elő, ha a deszerializálás során ismeretlen XmlSerializer típusú XML-csomópont jelenik meg.
UnreferencedObject	A SOAP kódolású XML-adatfolyam deszerializálása során fordul elő, amikor a XmlSerializer rendszer olyan felismert típussal találkozik, amelyet nem használnak vagy nem használnak.

Szálbiztonság

Ez a típus szálbiztos.

Lásd még

• XmlAttributeOverrides
• XmlAttributes
• XmlText
• Az XML-szerializálás bemutatása
• Útmutató: Alternatív elemnév megadása XML-adatfolyamhoz
• XML-szerializálás szabályozása attribútumokkal
• Példák XML-szerializálásra
• XML-sémadefiníciós eszköz (Xsd.exe)
• Útmutató: Származtatott osztályok szerializálásának szabályozása
• <dateTimeSerialization>elem
• <xmlSerializer> elem