XmlSerializer Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Serializuje a deserializuje objekty do a z dokumentů XML. Umožňuje XmlSerializer řídit, jak jsou objekty kódovány do XML.
public ref class XmlSerializer
public class XmlSerializer
type XmlSerializer = class
Public Class XmlSerializer
- Dědičnost
-
XmlSerializer
Příklady
Následující příklad obsahuje dvě hlavní třídy: PurchaseOrder a Test. Třída PurchaseOrder obsahuje informace o jednom nákupu. Třída Test obsahuje metody, které vytvářejí nákupní objednávku a které čtou vytvořenou nákupní objednávku.
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
Poznámky
Serializace XML je proces převodu veřejných vlastností a polí objektu do sériového formátu (v tomto případě XML) pro ukládání nebo přenos. Deserializace znovu vytvoří objekt v původním stavu z výstupu XML. Serializace si můžete představit jako způsob uložení stavu objektu do datového proudu nebo vyrovnávací paměti. Například ASP.NET používá XmlSerializer třídu ke kódování zpráv webové služby XML.
Data ve vašich objektech jsou popsána pomocí konstruktorů programovacího jazyka, jako jsou třídy, pole, vlastnosti, primitivní typy, pole a dokonce vložený XML ve formě XmlElement nebo XmlAttribute objekty. K vygenerování tříd založených na existující definici schématu XML (XSD) máte možnost vytvořit vlastní třídy, anotovat je pomocí atributů nebo pomocí nástroje pro definici schématu XML (Xsd.exe). Pokud máte schéma XML, můžete spustit Xsd.exe, abyste vytvořili sadu tříd, které jsou silně typizované podle schématu a anotované s atributy, které dodržují schéma při serializaci.
Pro přenos dat mezi objekty a XML vyžaduje mapování z konstruktorů programovacího jazyka na schéma XML a ze schématu XML do konstruktorů programovacího jazyka. Nástroje XmlSerializer a související nástroje, jako je Xsd.exe, poskytují most mezi těmito dvěma technologiemi v době návrhu i za běhu. V době návrhu použijte Xsd.exe k vytvoření dokumentu schématu XML (.xsd) z vlastních tříd nebo k vytvoření tříd z daného schématu. V obou případech jsou třídy opatřeny vlastními atributy, které instruují XmlSerializer, jak mapovat mezi systémem schémat XML a obecným modulem CLR (Common Language Runtime). Za běhu lze instance tříd serializovat do dokumentů XML, které následují za daným schématem. Podobně lze tyto dokumenty XML deserializovat do objektů modulu runtime. Všimněte si, že schéma XML je volitelné a nevyžaduje se v době návrhu nebo za běhu.
Kontrola generovaného XML
Pokud chcete řídit vygenerovaný KÓD XML, můžete použít speciální atributy na třídy a členy. Chcete-li například zadat jiný název elementu XML, použijte XmlElementAttribute na veřejné pole nebo vlastnost a nastavte ElementName vlastnost. Úplný seznam podobných atributů naleznete v části Atributy, které řídí serializaci XML. Můžete také implementovat IXmlSerializable rozhraní pro řízení výstupu XML.
Pokud vygenerovaný kód XML musí odpovídat oddílu 5 dokumentu World Wide Consortium, protokol SOAP (Simple Object Access Protocol) 1.1, musíte vytvořit XmlSerializer pomocí XmlTypeMapping. Chcete-li dále řídit kódovaný kód SOAP XML, použijte atributy uvedené v atributech, které řídí kódované serializace SOAP.
S XmlSerializer můžete využít výhod práce se silně typovanými třídami a přitom mít neustále flexibilitu XML. Pomocí polí nebo vlastností typu XmlElementnebo XmlAttributeXmlNode ve třídách silného typu můžete číst části dokumentu XML přímo do objektů XML.
Pokud pracujete s rozšiřitelnými schématy XML, můžete také použít XmlAnyElementAttribute atributy k serializaci a XmlAnyAttributeAttribute deserializaci elementů nebo atributů, které nejsou nalezeny v původním schématu. Chcete-li použít objekty, použijte XmlAnyElementAttribute u pole, které vrací pole XmlElement objektů, nebo použijte XmlAnyAttributeAttribute pole, které vrací pole XmlAttribute objektů.
Pokud vlastnost nebo pole vrátí komplexní objekt (například pole nebo instanci třídy), XmlSerializer převede ho na prvek vnořený v hlavním dokumentu XML. Například první třída v následujícím kódu vrátí instanci druhé třídy.
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;
}
Serializovaný výstup XML vypadá takto:
<MyClass>
<MyObjectProperty>
<ObjectName>My String</ObjectName>
</MyObjectProperty>
</MyClass>
Pokud schéma obsahuje volitelný prvek (minOccurs = '0'), nebo pokud schéma obsahuje výchozí hodnotu, máte dvě možnosti. Jednou z možností je System.ComponentModel.DefaultValueAttribute zadat výchozí hodnotu, jak je znázorněno v následujícím kódu.
Public Class PurchaseOrder
<System.ComponentModel.DefaultValueAttribute ("2002")> _
Public Year As String
End Class
public class PurchaseOrder
{
[System.ComponentModel.DefaultValueAttribute ("2002")]
public string Year;
}
Další možností je použití speciálního vzoru k vytvoření logického pole rozpoznané podle XmlSerializer a použití XmlIgnoreAttribute na pole. Vzor je vytvořen ve formě propertyNameSpecified. Pokud je například pole s názvem "MyFirstName", vytvořili byste také pole s názvem "MyFirstNameSpecified", které dává pokyn, zda má vygenerovat XmlSerializer element XML s názvem "MyFirstName". To je ukázáno v následujícím příkladu.
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;
}
Přepsání výchozí serializace
Serializaci libovolné sady objektů a jejich vlastností můžete také přepsat tak, že vytvoříte jeden z příslušných atributů a přidáte ho do instance XmlAttributes třídy. Přepsání serializace tímto způsobem má dvě použití: nejprve můžete řídit a rozšířit serializaci objektů nalezených v knihovně DLL, i když nemáte přístup ke zdroji; zadruhé, můžete vytvořit jednu sadu serializovatelných tříd, ale serializovat objekty několika způsoby. Další podrobnosti naleznete ve třídě XmlAttributeOverrides a Jak na to: Ovládání serializace odvozených tříd.
Chcete-li serializovat objekt, zavolejte metodu Serialize . Chcete-li deserializovat objekt, zavolejte metodu Deserialize .
Chcete-li do dokumentu XML přidat obory názvů, viz XmlSerializerNamespaces.
Note
Dává XmlSerializer zvláštní zacházení třídám, které implementují IEnumerable nebo ICollection. Třída, která implementuje IEnumerable , musí implementovat veřejnou Add metodu, která přebírá jeden parametr. Parametr Add metody musí být stejného typu, jako je vrácen z Current vlastnosti u hodnoty vrácené z GetEnumerator, nebo jedné ze základu tohoto typu. Třída, která implementuje ICollection (například CollectionBase) navíc IEnumerable musí mít veřejnou Item indexovanou vlastnost (indexer v jazyce C#), která přebírá celé číslo a musí mít veřejnou Count vlastnost typu integer. Parametr metody Add musí být stejného typu, jako typ vrácený vlastností Item, nebo jedním ze základních typů tohoto typu. Pro třídy, které implementují ICollection, hodnoty, které mají být serializovány jsou načteny z indexované Item vlastnosti, nikoli voláním GetEnumerator.
K deserializaci objektu musíte mít oprávnění k zápisu do dočasného adresáře (jak je definováno proměnnou prostředí TEMP).
Dynamicky generovaná sestavení
Aby se zvýšil výkon, infrastruktura serializace XML dynamicky generuje sestavení pro serializaci a deserializaci zadaných typů. Infrastruktura vyhledá a znovu použije tato sestavení. K tomuto chování dochází pouze při použití následujících konstruktorů:
XmlSerializer.XmlSerializer(Type)
XmlSerializer.XmlSerializer(Type, String)
Pokud použijete některý z dalších konstruktorů, vygeneruje se více verzí stejného sestavení a nikdy se neuvolní, což vede k úniku paměti a nízkému výkonu. Nejjednodušším řešením je použít jeden z dříve zmíněných dvou konstruktorů. V opačném případě je nutné ukládat sestavení do mezipamětiHashtable, jak je znázorněno v následujícím příkladu.
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.
Serializace ArrayList a obecného seznamu
Nelze XmlSerializer serializovat nebo deserializovat následující:
Serializace výčtů nepodepsaného dlouhého čísla
Nelze vytvořit instanci XmlSerializer pro serializaci výčtu, pokud jsou splněny následující podmínky: Výčet má datový typ unsigned long (ulong v jazyce C#) a obsahuje libovolného člena s hodnotou větší než 9 223 372 036 854 775 807. Například následující nelze serializovat.
public enum LargeNumbers: ulong
{
a = 9223372036854775808
}
// At runtime, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));
Zastaralé typy
Třída XmlSerializer serializuje objekty, které jsou označeny jako [Obsolete].
Konstruktory
| Name | Description |
|---|---|
| XmlSerializer() |
Inicializuje novou instanci XmlSerializer třídy. |
| XmlSerializer(Type, String) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat xml dokumenty do objektů zadaného typu. Určuje výchozí obor názvů pro všechny elementy XML. |
| XmlSerializer(Type, Type[]) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat xml dokumenty do objektu zadaného typu. Pokud vlastnost nebo pole vrátí matici, |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence) |
Zastaralé.
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do instancí dokumentu XML a deserializovat instance dokumentu XML do objektů zadaného typu. Toto přetížení umožňuje zadat další typy, které mohou být zjištěny během serializace nebo deserializace operace, stejně jako výchozí obor názvů pro všechny elementy XML, třída použít jako kořenový element XML, jeho umístění a přihlašovací údaje požadované pro přístup. |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty typu Object do instancí dokumentu XML a deserializovat instance dokumentu XML do objektů typu Object. Každý objekt, který má být serializován, může sám obsahovat instance tříd, které toto přetížení přepíše s jinými třídami. Toto přetížení také určuje výchozí obor názvů pro všechny elementy XML a třídu, která se má použít jako kořenový element XML. |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty typu Object do instancí dokumentu XML a deserializovat instance dokumentu XML do objektů typu Object. Každý objekt, který má být serializován, může sám obsahovat instance tříd, které toto přetížení přepíše s jinými třídami. Toto přetížení také určuje výchozí obor názvů pro všechny elementy XML a třídu, která se má použít jako kořenový element XML. |
| XmlSerializer(Type, XmlAttributeOverrides) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat xml dokumenty do objektů zadaného typu. Každý objekt, který má být serializován, může sám obsahovat instance tříd, které toto přetížení může přepsat s jinými třídami. |
| XmlSerializer(Type, XmlRootAttribute) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat dokument XML do objektu zadaného typu. Určuje také třídu, která se má použít jako kořenový element XML. |
| XmlSerializer(Type) |
Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat xml dokumenty do objektů zadaného typu. |
| XmlSerializer(XmlTypeMapping) |
Inicializuje instanci XmlSerializer třídy pomocí objektu, který mapuje jeden typ na jiný. |
Metody
| Name | Description |
|---|---|
| CanDeserialize(XmlReader) |
Získá hodnotu, která určuje, zda to XmlSerializer může deserializovat zadaný dokument XML. |
| CreateReader() |
Vrátí objekt použitý ke čtení dokumentu XML, který má být serializován. |
| CreateWriter() |
Při přepsání v odvozené třídě vrátí zapisovač použitý k serializaci objektu. |
| Deserialize(Stream) |
Deserializuje dokument XML obsažený zadaným Stream. |
| Deserialize(TextReader) |
Deserializuje dokument XML obsažený zadaným TextReader. |
| Deserialize(XmlReader, String, XmlDeserializationEvents) |
Deserializuje objekt pomocí dat obsažených v zadaném XmlReaderobjektu . |
| Deserialize(XmlReader, String) |
Deserializuje dokument XML obsažený v zadaném XmlReader a kódovacím stylu. |
| Deserialize(XmlReader, XmlDeserializationEvents) |
Deserializuje dokument XML obsažený v zadaném XmlReader dokumentu a umožňuje přepsání událostí, ke kterým dochází během deserializace. |
| Deserialize(XmlReader) |
Deserializuje dokument XML obsažený zadaným XmlReader. |
| Deserialize(XmlSerializationReader) |
Deserializuje dokument XML obsažený zadaným XmlSerializationReader. |
| Equals(Object) |
Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object) |
| FromMappings(XmlMapping[], Evidence) |
Zastaralé.
Vrátí instanci XmlSerializer třídy vytvořené z mapování jednoho typu XML na jiný. |
| FromMappings(XmlMapping[], Type) |
Vrátí instanci XmlSerializer třídy ze zadaných mapování. |
| FromMappings(XmlMapping[]) |
Vrátí pole objektů vytvořených XmlSerializerXmlTypeMapping z pole objektů. |
| FromTypes(Type[]) |
Vrátí pole objektů vytvořených XmlSerializer z pole typů. |
| GenerateSerializer(Type[], XmlMapping[], CompilerParameters) |
Vrátí sestavení, které obsahuje vlastní serializátory používané k serializaci nebo deserializaci zadaného typu nebo typů pomocí zadaných mapování a nastavení a možností kompilátoru. |
| GenerateSerializer(Type[], XmlMapping[]) |
Vrátí sestavení, které obsahuje vlastní serializátory používané k serializaci nebo deserializaci zadaného typu nebo typů pomocí zadaných mapování. |
| GetHashCode() |
Slouží jako výchozí funkce hash. (Zděděno od Object) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| GetXmlSerializerAssemblyName(Type, String) |
Vrátí název sestavení, které obsahuje serializátor pro zadaný typ v zadaném oboru názvů. |
| GetXmlSerializerAssemblyName(Type) |
Vrátí název sestavení, které obsahuje jednu nebo více verzí zvlášť vytvořených XmlSerializer pro serializaci nebo deserializaci zadaného typu. |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
| Serialize(Object, XmlSerializationWriter) |
Serializuje zadaný Object a zapisuje xml dokument do souboru pomocí zadaného XmlSerializationWriter. |
| Serialize(Stream, Object, XmlSerializerNamespaces) |
Serializuje zadaný Object a zapíše dokument XML do souboru pomocí zadané Stream odkazy na zadané obory názvů. |
| Serialize(Stream, Object) |
Serializuje zadaný Object a zapisuje xml dokument do souboru pomocí zadaného Stream. |
| Serialize(TextWriter, Object, XmlSerializerNamespaces) |
Serializuje zadaný Object a zapisuje dokument XML do souboru pomocí zadaných TextWriter oborů názvů a odkazuje na zadané obory názvů. |
| Serialize(TextWriter, Object) |
Serializuje zadaný Object a zapisuje xml dokument do souboru pomocí zadaného TextWriter. |
| Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String) |
Serializuje zadaný Object a zapisuje dokument XML do souboru pomocí zadaných XmlWriteroborů názvů XML a kódování. |
| Serialize(XmlWriter, Object, XmlSerializerNamespaces, String) |
Serializuje zadaný objekt a zapíše dokument XML do souboru pomocí zadaného XmlWriter oboru názvů a odkazuje na zadané obory názvů a styl kódování. |
| Serialize(XmlWriter, Object, XmlSerializerNamespaces) |
Serializuje zadaný Object a zapisuje dokument XML do souboru pomocí zadaných XmlWriter oborů názvů a odkazuje na zadané obory názvů. |
| Serialize(XmlWriter, Object) |
Serializuje zadaný Object a zapisuje xml dokument do souboru pomocí zadaného XmlWriter. |
| ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |
Událost
| Name | Description |
|---|---|
| UnknownAttribute |
Nastane v případě, že při deserializaci dojde k XmlSerializer atributu XML neznámého typu. |
| UnknownElement |
Nastane, XmlSerializer když dojde k výskytu XML elementu neznámého typu během deserializace. |
| UnknownNode |
Nastane, když dojde k XmlSerializer uzlu XML neznámého typu během deserializace. |
| UnreferencedObject |
Nastane při deserializaci xml streamu kódovaného protokolem SOAP, když XmlSerializer narazí na rozpoznaný typ, který není použit nebo není odvozen. |
Platí pro
Bezpečný přístup z více vláken
Tento typ je bezpečný pro přístup z více vláken.
Viz také
- XmlAttributeOverrides
- XmlAttributes
- XmlText
- Představujeme serializaci XML
- Postupy: Určení alternativního názvu elementu pro datový proud XML
- Řízení serializace XML pomocí atributů
- Příklady serializace XML
- Nástroj XML Schema Definition (Xsd.exe)
- Postupy: Řízení serializace odvozených tříd
- <dateTimeSerialization>– element
- <xmlSerializer> – element