XmlSerializer Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Serializa e desserializa objetos em e a partir de documentos XML. Permite-te XmlSerializer controlar como os objetos são codificados em XML.
public ref class XmlSerializer
public class XmlSerializer
type XmlSerializer = class
Public Class XmlSerializer
- Herança
-
XmlSerializer
Exemplos
O exemplo seguinte contém duas classes principais: PurchaseOrder e Test. A PurchaseOrder aula contém informações sobre uma única compra. A Test classe contém os métodos que criam a ordem de compra e que leem a ordem de compra criada.
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
Observações
A serialização XML é o processo de conversão de propriedades públicas e campos de um objeto em um formato serial (neste caso, XML) para armazenamento ou transporte. A desserialização recria o objeto em seu estado original a partir da saída XML. Você pode pensar na serialização como uma maneira de salvar o estado de um objeto em um fluxo ou buffer. Por exemplo, ASP.NET usa a XmlSerializer classe para codificar mensagens do XML Web Service.
Os dados em seus objetos são descritos usando construções de linguagem de programação como classes, campos, propriedades, tipos primitivos, matrizes e até XML incorporado na forma de XmlElement ou XmlAttribute objetos. Você tem a opção de criar suas próprias classes, anotadas com atributos, ou usar a Ferramenta de Definição de Esquema XML (Xsd.exe) para gerar as classes com base em um documento de definição de esquema XML (XSD) existente. Se tiver um esquema XML, pode executar o Xsd.exe para produzir um conjunto de classes que são fortemente tipificadas para o esquema e anotadas com atributos para aderir ao esquema quando serializadas.
Para transferir dados entre objetos e XML requer um mapeamento das construções da linguagem de programação para o esquema XML e do esquema XML para as construções da linguagem de programação. O XmlSerializer e ferramentas relacionadas, como Xsd.exe, fornecem a ponte entre essas duas tecnologias tanto em tempo de conceção como em tempo de execução. Em tempo de design, use o Xsd.exe para produzir um documento de esquema XML (.xsd) de suas classes personalizadas ou para produzir classes de um determinado esquema. Em ambos os casos, as classes são anotadas com atributos personalizados para instruir o XmlSerializer como mapear entre o sistema de esquema XML e o Common Language Runtime. No tempo de execução, as instâncias das classes podem ser serializadas em documentos XML que seguem o esquema fornecido. Da mesma forma, esses documentos XML podem ser desserializados em objetos em tempo de execução. Observe que o esquema XML é opcional e não é necessário em tempo de design ou tempo de execução.
XML gerado pelo controle
Para controlar o XML gerado, você pode aplicar atributos especiais a classes e membros. Por exemplo, para especificar um nome de elemento XML diferente, aplique um XmlElementAttribute a um campo ou propriedade pública e defina a ElementName propriedade. Para obter uma lista completa de atributos semelhantes, consulte Atributos que controlam a serialização XML. Você também pode implementar a IXmlSerializable interface para controlar a saída XML.
Se o XML gerado deve estar em conformidade com a seção 5 do documento do World Wide Consortium, Simple Object Access Protocol (SOAP) 1.1, deve-se construir o XmlSerializer com um XmlTypeMapping. Para controlar ainda mais o XML SOAP codificado, use os atributos listados em Atributos que controlam a serialização SOAP codificada.
Com o XmlSerializer você pode tirar proveito de trabalhar com classes fortemente tipadas e ainda ter a flexibilidade de XML. Usando campos ou propriedades do tipo XmlElement, XmlAttribute ou XmlNode em suas classes fortemente tipadas, você pode ler partes do documento XML diretamente em objetos XML.
Se você trabalha com esquemas XML extensíveis, também pode usar os XmlAnyElementAttribute atributos e XmlAnyAttributeAttribute para serializar e desserializar elementos ou atributos que não são encontrados no esquema original. Para usar os objetos, aplique um XmlAnyElementAttribute a um campo que retorna uma matriz de XmlElement objetos ou aplique um XmlAnyAttributeAttribute a um campo que retorna uma matriz de XmlAttribute objetos.
Se uma propriedade ou campo retornar um objeto complexo (como uma matriz ou uma instância de classe), o XmlSerializer converte-o em um elemento aninhado no documento XML principal. Por exemplo, a primeira classe no código a seguir retorna uma instância da segunda classe.
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 saída XML serializada tem esta aparência:
<MyClass>
<MyObjectProperty>
<ObjectName>My String</ObjectName>
</MyObjectProperty>
</MyClass>
Se um esquema incluir um elemento que é opcional (minOccurs = '0'), ou se o esquema incluir um valor padrão, você terá duas opções. Uma opção é usar System.ComponentModel.DefaultValueAttribute para especificar o valor padrão, conforme mostrado no código a seguir.
Public Class PurchaseOrder
<System.ComponentModel.DefaultValueAttribute ("2002")> _
Public Year As String
End Class
public class PurchaseOrder
{
[System.ComponentModel.DefaultValueAttribute ("2002")]
public string Year;
}
Outra opção é usar um padrão especial para criar um campo booleano reconhecido pelo XmlSerializer, e aplicar o XmlIgnoreAttribute ao campo. O padrão é criado na forma de propertyNameSpecified. Por exemplo, se houver um campo chamado "MyFirstName", você também criaria um campo chamado "MyFirstNameSpecified" que instrui o XmlSerializer sobre se deve gerar o elemento XML chamado "MyFirstName". Isso é mostrado no exemplo a seguir.
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;
}
Substituir a serialização padrão
Você também pode substituir a serialização de qualquer conjunto de objetos e seus campos e propriedades criando um dos atributos apropriados e adicionando-o a uma instância da XmlAttributes classe. Substituir a serialização dessa maneira tem dois usos: primeiro, você pode controlar e aumentar a serialização de objetos encontrados em uma DLL, mesmo que você não tenha acesso à fonte; Em segundo lugar, você pode criar um conjunto de classes serializáveis, mas serializar os objetos de várias maneiras. Para mais detalhes, consulte a classe XmlAttributeOverrides e Como: Controlar a serialização de classes derivadas.
Para serializar um objeto, chame o Serialize método. Para desserializar um objeto, chame o Deserialize método.
Para adicionar namespaces XML a um documento XML, consulte XmlSerializerNamespaces.
Note
O XmlSerializer dá tratamento especial às classes que implementam IEnumerable ou ICollection. Uma classe que implementa IEnumerable deve implementar um método público Add que usa um único parâmetro. O parâmetro do método Add deve ser do mesmo tipo do valor retornado pela propriedade Current em GetEnumerator, ou de uma das suas bases. Uma classe que implementa ICollection (como CollectionBase) além de IEnumerable deve ter uma propriedade indexada pública Item (indexador em C#) que usa um inteiro e deve ter uma propriedade pública Count do tipo inteiro. O parâmetro para o Add método deve ser do mesmo tipo que é retornado da Item propriedade ou uma das bases desse tipo. Para classes que implementam ICollection, os valores a serem serializados são recuperados da propriedade indexada Item , não chamando GetEnumerator.
Você deve ter permissão para gravar no diretório temporário (conforme definido pela variável de ambiente TEMP) para desserializar um objeto.
Montagens geradas dinamicamente
Para aumentar o desempenho, a infraestrutura de serialização XML gera dinamicamente assemblies para serializar e desserializar tipos especificados. A infraestrutura localiza e reutiliza esses conjuntos. Esse comportamento ocorre somente ao usar os seguintes construtores:
XmlSerializer.XmlSerializer(Type)
XmlSerializer.XmlSerializer(Type, String)
Se você usar qualquer um dos outros construtores, várias versões do mesmo assembly serão geradas e nunca descarregadas, o que resulta em um vazamento de memória e baixo desempenho. A solução mais simples é usar um dos dois construtores mencionados anteriormente. Caso contrário, deves armazenar em cache os assemblies em um Hashtable, conforme mostrado no exemplo a seguir.
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.
Serialização de ArrayList e lista genérica
O XmlSerializer não pode serializar ou desserializar o seguinte:
Serialização de enumerações de Long não assinado
O XmlSerializer não pode ser instanciado para serializar uma enumeração se as seguintes condições forem verdadeiras: A enumeração é do tipo long não assinado (ulong em C#) e a enumeração contém qualquer membro com um valor maior que 9.223.372.036.854.775.807. Por exemplo, o seguinte não pode ser serializado.
public enum LargeNumbers: ulong
{
a = 9223372036854775808
}
// At runtime, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));
Tipos obsoletos
A XmlSerializer classe não serializa objetos marcados como [Obsolete].
Construtores
| Name | Descrição |
|---|---|
| XmlSerializer() |
Inicializa uma nova instância da XmlSerializer classe. |
| XmlSerializer(Type, String) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo especificado em documentos XML e desserializar documentos XML em objetos do tipo especificado. Especifica o namespace padrão para todos os elementos XML. |
| XmlSerializer(Type, Type[]) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo especificado em documentos XML e desserializar documentos XML em objetos de um tipo especificado. Se uma propriedade ou campo devolver um array, o |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence) |
Obsoleto.
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo especificado em instâncias de documento XML e desserializar instâncias de documentos XML em objetos do tipo especificado. Esta sobrecarga permite fornecer outros tipos que podem ser encontrados durante uma operação de serialização ou desserialização, bem como um namespace padrão para todos os elementos XML, a classe a usar como elemento raiz XML, a sua localização e credenciais necessárias para o acesso. |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo Object em instâncias de documentos XML e desserializar instâncias de documentos XML em objetos do tipo Object. Cada objeto a serializar pode conter instâncias de classes, que esta sobrecarga sobrepõe com outras classes. Esta sobrecarga também especifica o namespace padrão para todos os elementos XML e a classe a usar como elemento raiz XML. |
| XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo Object em instâncias de documentos XML e desserializar instâncias de documentos XML em objetos do tipo Object. Cada objeto a serializar pode conter instâncias de classes, que esta sobrecarga sobrepõe com outras classes. Esta sobrecarga também especifica o namespace padrão para todos os elementos XML e a classe a usar como elemento raiz XML. |
| XmlSerializer(Type, XmlAttributeOverrides) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo especificado em documentos XML e desserializar documentos XML em objetos do tipo especificado. Cada objeto a serializar pode conter instâncias de classes, que esta sobrecarga pode sobrepor com outras classes. |
| XmlSerializer(Type, XmlRootAttribute) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo especificado em documentos XML e desserializar um documento XML em objeto do tipo especificado. Também especifica a classe a usar como elemento raiz XML. |
| XmlSerializer(Type) |
Inicializa uma nova instância da XmlSerializer classe que pode serializar objetos do tipo especificado em documentos XML e desserializar documentos XML em objetos do tipo especificado. |
| XmlSerializer(XmlTypeMapping) |
Inicializa uma instância da XmlSerializer classe usando um objeto que mapeia um tipo para outro. |
Métodos
| Name | Descrição |
|---|---|
| CanDeserialize(XmlReader) |
Obtém um valor que indica se isto XmlSerializer pode desserializar um documento XML especificado. |
| CreateReader() |
Devolve um objeto usado para ler o documento XML a ser serializado. |
| CreateWriter() |
Quando sobreposto numa classe derivada, devolve um escritor usado para serializar o objeto. |
| Deserialize(Stream) |
Desserializa o documento XML contido pelo especificado Stream. |
| Deserialize(TextReader) |
Desserializa o documento XML contido pelo especificado TextReader. |
| Deserialize(XmlReader, String, XmlDeserializationEvents) |
Desserializa o objeto usando os dados contidos pelo especificado XmlReader. |
| Deserialize(XmlReader, String) |
Desserializa o documento XML contido pelo estilo especificado XmlReader e de codificação. |
| Deserialize(XmlReader, XmlDeserializationEvents) |
Desserializa um documento XML contido pelo especificado XmlReader e permite a sobreposição de eventos que ocorrem durante a desserialização. |
| Deserialize(XmlReader) |
Desserializa o documento XML contido pelo especificado XmlReader. |
| Deserialize(XmlSerializationReader) |
Desserializa o documento XML contido pelo especificado XmlSerializationReader. |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| FromMappings(XmlMapping[], Evidence) |
Obsoleto.
Devolve uma instância da XmlSerializer classe criada a partir de mapeamentos de um tipo XML para outro. |
| FromMappings(XmlMapping[], Type) |
Devolve uma instância da XmlSerializer classe a partir dos mapeamentos especificados. |
| FromMappings(XmlMapping[]) |
Devolve um array de XmlSerializer objetos criado a partir de um array de XmlTypeMapping objetos. |
| FromTypes(Type[]) |
Devolve um array de XmlSerializer objetos criados a partir de um array de tipos. |
| GenerateSerializer(Type[], XmlMapping[], CompilerParameters) |
Devolve um assembly que contém serializadores personalizados usados para serializar ou desserializar o tipo ou tipos especificados, usando os mapeamentos e definições e opções do compilador especificados. |
| GenerateSerializer(Type[], XmlMapping[]) |
Devolve um conjunto que contém serializadores personalizados usados para serializar ou desserializar o tipo ou tipos especificados, usando os mapeamentos especificados. |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| GetXmlSerializerAssemblyName(Type, String) |
Devolve o nome do assembly que contém o serializador para o tipo especificado no espaço de nomes especificado. |
| GetXmlSerializerAssemblyName(Type) |
Devolve o nome do assembly que contém uma ou mais versões do XmlSerializer especialmente criadas para serializar ou desserializar o tipo especificado. |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| Serialize(Object, XmlSerializationWriter) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o ficheiro especificado XmlSerializationWriter. |
| Serialize(Stream, Object, XmlSerializerNamespaces) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o especificado Stream que faz referência aos espaços de nomes especificados. |
| Serialize(Stream, Object) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o ficheiro especificado Stream. |
| Serialize(TextWriter, Object, XmlSerializerNamespaces) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o especificado TextWriter e faz referência aos espaços de nomes especificados. |
| Serialize(TextWriter, Object) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o ficheiro especificado TextWriter. |
| Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando os espaços de nomes XML especificados XmlWritere a codificação. |
| Serialize(XmlWriter, Object, XmlSerializerNamespaces, String) |
Serializa o objeto especificado e escreve o documento XML num ficheiro usando o especificado XmlWriter e faz referência aos namespaces e estilo de codificação especificados. |
| Serialize(XmlWriter, Object, XmlSerializerNamespaces) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o especificado XmlWriter e faz referência aos espaços de nomes especificados. |
| Serialize(XmlWriter, Object) |
Serializa o especificado Object e escreve o documento XML num ficheiro usando o ficheiro especificado XmlWriter. |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |
Eventos
| Name | Descrição |
|---|---|
| UnknownAttribute |
Ocorre quando encontra XmlSerializer um atributo XML de tipo desconhecido durante a desserialização. |
| UnknownElement |
Ocorre quando encontra XmlSerializer um elemento XML de tipo desconhecido durante a desserialização. |
| UnknownNode |
Ocorre quando encontra XmlSerializer um nó XML de tipo desconhecido durante a desserialização. |
| UnreferencedObject |
Ocorre durante a desserialização de um fluxo XML codificado em SOAP, quando encontra XmlSerializer um tipo reconhecido que não é utilizado ou não está referenciado. |
Aplica-se a
Segurança de Thread
Este tipo é seguro para fios.
Ver também
- XmlAttributeOverrides
- XmlAttributes
- XmlText
- Apresentando a serialização XML
- Como: Especificar um nome de elemento alternativo para um fluxo XML
- Controlando a serialização XML usando atributos
- Exemplos de serialização XML
- Ferramenta de definição de esquema XML (Xsd.exe)
- Como: Controlar a Serialização de Classes Derivadas
- <Elemento dateTimeSerialization>
- <xmlSerializer> Element