Partilhar via


XmlAttributes Classe

Definição

Representa uma coleção de objetos de atributo que controlam como o XmlSerializer serializa e desserializa um objeto.

public ref class XmlAttributes
public class XmlAttributes
type XmlAttributes = class
Public Class XmlAttributes
Herança
XmlAttributes

Exemplos

O exemplo a seguir serializa uma instância de uma classe chamada Orchestra, que contém um único campo chamado Instruments que retorna uma matriz de Instrument objetos. Uma segunda classe chamada Brass herda da Instrument classe. O exemplo cria um XmlAttributes objeto para substituir o Instrument campo, permitindo que o campo aceite Brass objetos, e adiciona o XmlAttributes objeto a uma instância da XmlAttributeOverrides classe.

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

public class Orchestra
{
   public Instrument[] Instruments;
}

public class Instrument
{
   public string Name;
}

public class Brass:Instrument
{
   public bool IsValved;
}

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

    public void SerializeObject(string filename)
    {
      /* Each overridden field, property, or type requires
      an XmlAttributes object. */
      XmlAttributes attrs = new XmlAttributes();

      /* Create an XmlElementAttribute to override the
      field that returns Instrument objects. The overridden field
      returns Brass objects instead. */
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the element to the collection of elements.
      attrs.XmlElements.Add(attr);

      // Create the XmlAttributeOverrides object.
      XmlAttributeOverrides attrOverrides = new XmlAttributeOverrides();

      /* Add the type of the class that contains the overridden
      member and the XmlAttributes to override it with to the
      XmlAttributeOverrides object. */
      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

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

      // Create the object that will be serialized.
      Orchestra band = new Orchestra();

      // Create an object of the derived type.
      Brass i = new Brass();
      i.Name = "Trumpet";
      i.IsValved = true;
      Instrument[] myInstruments = {i};
      band.Instruments = myInstruments;

      // Serialize the object.
      s.Serialize(writer,band);
      writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlAttributeOverrides attrOverrides =
         new XmlAttributeOverrides();
      XmlAttributes attrs = new XmlAttributes();

      // Create an XmlElementAttribute to override the Instrument.
      XmlElementAttribute attr = new XmlElementAttribute();
      attr.ElementName = "Brass";
      attr.Type = typeof(Brass);

      // Add the element to the collection of elements.
      attrs.XmlElements.Add(attr);

      attrOverrides.Add(typeof(Orchestra), "Instruments", attrs);

      // Create the XmlSerializer using the XmlAttributeOverrides.
      XmlSerializer s =
      new XmlSerializer(typeof(Orchestra), attrOverrides);

      FileStream fs = new FileStream(filename, FileMode.Open);
      Orchestra band = (Orchestra) s.Deserialize(fs);
      Console.WriteLine("Brass:");

      /* The difference between deserializing the overridden
      XML document and serializing it is this: To read the derived
      object values, you must declare an object of the derived type
      (Brass), and cast the Instrument instance to it. */
      Brass b;
      foreach(Instrument i in band.Instruments)
      {
         b = (Brass)i;
         Console.WriteLine(
         b.Name + "\n" +
         b.IsValved);
      }
   }
}
Imports System.IO
Imports System.Xml.Serialization

Public Class Orchestra
    Public Instruments() As Instrument
End Class

Public Class Instrument
    Public Name As String
End Class

Public Class Brass
    Inherits Instrument
    Public IsValved As Boolean
End Class


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Override.xml")
        test.DeserializeObject("Override.xml")
    End Sub    
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Each overridden field, property, or type requires
        ' an XmlAttributes object. 
        Dim attrs As New XmlAttributes()
        
        ' Create an XmlElementAttribute to override the
        ' field that returns Instrument objects. The overridden field
        ' returns Brass objects instead. 
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)
        
        ' Add the element to the collection of elements.
        attrs.XmlElements.Add(attr)
        
        ' Create the XmlAttributeOverrides object.
        Dim attrOverrides As New XmlAttributeOverrides()
        
        ' Add the type of the class that contains the overridden
        ' member and the XmlAttributes to override it with to the
        ' XmlAttributeOverrides object. 
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        ' Create the XmlSerializer using the XmlAttributeOverrides.
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create the object that will be serialized.
        Dim band As New Orchestra()
        
        ' Create an object of the derived type.
        Dim i As New Brass()
        i.Name = "Trumpet"
        i.IsValved = True
        Dim myInstruments() As Instrument = {i}
        band.Instruments = myInstruments
        
        ' Serialize the object.
        s.Serialize(writer, band)
        writer.Close()
    End Sub
    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim attrOverrides As New XmlAttributeOverrides()
        Dim attrs As New XmlAttributes()
        
        ' Create an XmlElementAttribute to override the Instrument.
        Dim attr As New XmlElementAttribute()
        attr.ElementName = "Brass"
        attr.Type = GetType(Brass)
        
        ' Add the element to the collection of elements.
        attrs.XmlElements.Add(attr)
        
        attrOverrides.Add(GetType(Orchestra), "Instruments", attrs)
        
        ' Create the XmlSerializer using the XmlAttributeOverrides.
        Dim s As New XmlSerializer(GetType(Orchestra), attrOverrides)
        
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim band As Orchestra = CType(s.Deserialize(fs), Orchestra)
        Console.WriteLine("Brass:")
        
        ' The difference between deserializing the overridden
        ' XML document and serializing it is this: To read the derived
        ' object values, you must declare an object of the derived type
        ' (Brass), and cast the Instrument instance to it. 
        Dim b As Brass
        Dim i As Instrument
        For Each i In  band.Instruments
            b = CType(i, Brass)
            Console.WriteLine(b.Name + ControlChars.Cr + _
                              b.IsValved.ToString())
        Next i
    End Sub
End Class

Comentários

A criação faz XmlAttributes parte de um processo que substitui a maneira padrão de serialização das XmlSerializer instâncias de classe. Por exemplo, suponha que você queira serializar um objeto criado a partir de uma DLL que tenha uma origem inacessível. Usando o XmlAttributeOverrides, você pode aumentar ou controlar como o objeto é serializado.

Os membros da XmlAttributes classe correspondem diretamente a uma família de classes de atributo que controlam a serialização. Por exemplo, a XmlText propriedade deve ser definida como um XmlTextAttribute, que permite substituir a serialização de um campo ou propriedade instruindo-o XmlSerializer a serializar o valor da propriedade como texto XML. Para obter uma lista completa de atributos que controlam a serialização, consulte o XmlSerializer.

Para obter mais detalhes sobre como usar a XmlAttributeOverridesXmlAttributes classe, consulte Como especificar um nome de elemento alternativo para um fluxo XML.

Construtores

Nome Description
XmlAttributes()

Inicializa uma nova instância da classe XmlAttributes.

XmlAttributes(ICustomAttributeProvider)

Inicializa uma nova instância da XmlAttributes classe e personaliza como o XmlSerializer serializa e desserializa um objeto.

Propriedades

Nome Description
XmlAnyAttribute

Obtém ou define a XmlAnyAttributeAttribute substituição.

XmlAnyElements

Obtém a coleção de XmlAnyElementAttribute objetos a serem substituídos.

XmlArray

Obtém ou define um objeto que especifica como serializa XmlSerializer um campo público ou uma propriedade de leitura/gravação que retorna uma matriz.

XmlArrayItems

Obtém ou define uma coleção de objetos que especificam como os XmlSerializer itens serializam inseridos em uma matriz retornada por um campo público ou propriedade de leitura/gravação.

XmlAttribute

Obtém ou define um objeto que especifica como serializa XmlSerializer um campo público ou uma propriedade pública de leitura/gravação como um atributo XML.

XmlChoiceIdentifier

Obtém ou define um objeto que permite distinguir entre um conjunto de opções.

XmlDefaultValue

Obtém ou define o valor padrão de um elemento ou atributo XML.

XmlElements

Obtém uma coleção de objetos que especificam como serializa XmlSerializer um campo público ou uma propriedade de leitura/gravação como um elemento XML.

XmlEnum

Obtém ou define um objeto que especifica como serializa XmlSerializer um membro de enumeração.

XmlIgnore

Obtém ou define um valor que especifica se o XmlSerializer campo público serializa ou não uma propriedade pública de leitura/gravação.

Xmlns

Obtém ou define um valor que especifica se todas as declarações de namespace devem ser mantidas quando um objeto que contém um membro que retorna um XmlSerializerNamespaces objeto é substituído.

XmlRoot

Obtém ou define um objeto que especifica como a XmlSerializer classe serializa como um elemento raiz XML.

XmlText

Obtém ou define um objeto que instrui a XmlSerializer serializar um campo público ou uma propriedade pública de leitura/gravação como texto XML.

XmlType

Obtém ou define um objeto que especifica como serializa XmlSerializer uma classe à qual a XmlTypeAttribute classe foi aplicada.

Métodos

Nome Description
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Objectatual.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Confira também