XmlAttributes Classe
Definição
Representa uma coleção de objetos de atributos que controlam como o XmlSerializer serializa e desserializa um objeto.Represents a collection of attribute objects that control how the XmlSerializer serializes and deserializes an object.
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.The following example serializes an instance of a class named Orchestra, which contains a single field named Instruments that returns an array of Instrument objects. Uma segunda classe denominada Brass herda da Instrument classe.A second class named Brass inherits from the Instrument class. 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.The example creates an XmlAttributes object to override the Instrument field--allowing the field to accept Brass objects--and adds the XmlAttributes object to an instance of the XmlAttributeOverrides class.
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
public ref class Instrument
{
public:
String^ Name;
};
public ref class Brass: public Instrument
{
public:
bool IsValved;
};
public ref class Orchestra
{
public:
array<Instrument^>^Instruments;
};
void SerializeObject( String^ filename )
{
/* Each overridden field, property, or type requires
an XmlAttributes object. */
XmlAttributes^ attrs = gcnew XmlAttributes;
/* Create an XmlElementAttribute to override the
field that returns Instrument objects. The overridden field
returns Brass objects instead. */
XmlElementAttribute^ attr = gcnew XmlElementAttribute;
attr->ElementName = "Brass";
attr->Type = Brass::typeid;
// Add the element to the collection of elements.
attrs->XmlElements->Add( attr );
// Create the XmlAttributeOverrides object.
XmlAttributeOverrides^ attrOverrides = gcnew 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( Orchestra::typeid, "Instruments", attrs );
// Create the XmlSerializer using the XmlAttributeOverrides.
XmlSerializer^ s = gcnew XmlSerializer( Orchestra::typeid,attrOverrides );
// Writing the file requires a TextWriter.
TextWriter^ writer = gcnew StreamWriter( filename );
// Create the object that will be serialized.
Orchestra^ band = gcnew Orchestra;
// Create an object of the derived type.
Brass^ i = gcnew Brass;
i->Name = "Trumpet";
i->IsValved = true;
array<Instrument^>^myInstruments = {i};
band->Instruments = myInstruments;
// Serialize the object.
s->Serialize( writer, band );
writer->Close();
}
void DeserializeObject( String^ filename )
{
XmlAttributeOverrides^ attrOverrides = gcnew XmlAttributeOverrides;
XmlAttributes^ attrs = gcnew XmlAttributes;
// Create an XmlElementAttribute to override the Instrument.
XmlElementAttribute^ attr = gcnew XmlElementAttribute;
attr->ElementName = "Brass";
attr->Type = Brass::typeid;
// Add the element to the collection of elements.
attrs->XmlElements->Add( attr );
attrOverrides->Add( Orchestra::typeid, "Instruments", attrs );
// Create the XmlSerializer using the XmlAttributeOverrides.
XmlSerializer^ s = gcnew XmlSerializer( Orchestra::typeid,attrOverrides );
FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
Orchestra^ band = dynamic_cast<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;
System::Collections::IEnumerator^ myEnum = band->Instruments->GetEnumerator();
while ( myEnum->MoveNext() )
{
Instrument^ i = safe_cast<Instrument^>(myEnum->Current);
b = dynamic_cast<Brass^>(i);
Console::WriteLine( "{0}\n{1}", b->Name, b->IsValved );
}
}
int main()
{
SerializeObject( "Override.xml" );
DeserializeObject( "Override.xml" );
}
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
Criar o XmlAttributes é parte de um processo que substitui a maneira padrão como o XmlSerializer serializa as instâncias de classe.Creating the XmlAttributes is part of a process that overrides the default way the XmlSerializer serializes class instances. Por exemplo, suponha que você queira serializar um objeto que é criado a partir de uma DLL que tem uma fonte inacessível.For example, suppose you want to serialize an object that is created from a DLL which has an inaccessible source. Usando o XmlAttributeOverrides , você pode aumentar ou controlar como o objeto é serializado.By using the XmlAttributeOverrides, you can augment or otherwise control how the object is serialized.
Os membros da XmlAttributes classe correspondem diretamente a uma família de classes de atributo que controlam a serialização.The members of the XmlAttributes class correspond directly to a family of attribute classes that control serialization. Por exemplo, a XmlText propriedade deve ser definida como um XmlTextAttribute , o que permite que você substitua a serialização de um campo ou Propriedade instruindo o a XmlSerializer serializar o valor da propriedade como texto XML.For example, the XmlText property must be set to an XmlTextAttribute, which allows you to override serialization of a field or property by instructing the XmlSerializer to serialize the property value as XML text. Para obter uma lista completa de atributos que controlam a serialização, consulte o XmlSerializer .For a complete list of attributes that control serialization, see the XmlSerializer.
Para obter mais detalhes sobre como usar o XmlAttributeOverrides com a XmlAttributes classe, consulte como especificar um nome de elemento alternativo para um fluxo XML.For more details on using the XmlAttributeOverrides with the XmlAttributes class, see How to: Specify an Alternate Element Name for an XML Stream.
Construtores
| XmlAttributes() |
Inicializa uma nova instância da classe XmlAttributes.Initializes a new instance of the XmlAttributes class. |
| XmlAttributes(ICustomAttributeProvider) |
Inicializa uma nova instância da classe XmlAttributes e personaliza a maneira como o XmlSerializer serializa e desserializa um objeto.Initializes a new instance of the XmlAttributes class and customizes how the XmlSerializer serializes and deserializes an object. |
Propriedades
| XmlAnyAttribute |
Obtém ou define a propriedade XmlAnyAttributeAttribute a ser substituída.Gets or sets the XmlAnyAttributeAttribute to override. |
| XmlAnyElements |
Obtém a coleção de objetos XmlAnyElementAttribute a serem substituídos.Gets the collection of XmlAnyElementAttribute objects to override. |
| XmlArray |
Obtém ou define um objeto que especifica como o XmlSerializer serializa um campo público ou uma propriedade de leitura/gravação que retorna uma matriz.Gets or sets an object that specifies how the XmlSerializer serializes a public field or read/write property that returns an array. |
| XmlArrayItems |
Obtém ou define uma coleção de objetos que especificam como o XmlSerializer serializa os itens inseridos em uma matriz retornada por um campo público ou uma propriedade de leitura/gravação.Gets or sets a collection of objects that specify how the XmlSerializer serializes items inserted into an array returned by a public field or read/write property. |
| XmlAttribute |
Obtém ou define um objeto que especifica como o XmlSerializer serializa um campo público ou uma propriedade de leitura/gravação pública como um atributo XML.Gets or sets an object that specifies how the XmlSerializer serializes a public field or public read/write property as an XML attribute. |
| XmlChoiceIdentifier |
Obtém ou define um objeto que permite distinguir entre um conjunto de opções.Gets or sets an object that allows you to distinguish between a set of choices. |
| XmlDefaultValue |
Obtém ou define o valor padrão de um atributo ou elemento XML.Gets or sets the default value of an XML element or attribute. |
| XmlElements |
Obtém uma coleção de objetos que especifica como o XmlSerializer serializa um campo público ou uma propriedade de leitura/gravação como um elemento XML.Gets a collection of objects that specify how the XmlSerializer serializes a public field or read/write property as an XML element. |
| XmlEnum |
Obtém ou define um objeto que especifica como o XmlSerializer serializa um membro de enumeração.Gets or sets an object that specifies how the XmlSerializer serializes an enumeration member. |
| XmlIgnore |
Obtém ou define um valor que especifica se o XmlSerializer serializa ou não um campo público ou uma propriedade de leitura/gravação pública.Gets or sets a value that specifies whether or not the XmlSerializer serializes a public field or public read/write property. |
| Xmlns |
Obtém ou define um valor que especifica se é necessário manter todas as declarações de namespace quando um objeto que contém um membro que retorna um objeto XmlSerializerNamespaces é substituído.Gets or sets a value that specifies whether to keep all namespace declarations when an object containing a member that returns an XmlSerializerNamespaces object is overridden. |
| XmlRoot |
Obtém ou define um objeto que especifica como o XmlSerializer serializa uma classe como um elemento raiz XML.Gets or sets an object that specifies how the XmlSerializer serializes a class as an XML root element. |
| XmlText |
Obtém ou define um objeto que instrui o XmlSerializer para serializar um campo público ou propriedade de leitura/gravação pública como texto XML.Gets or sets an object that instructs the XmlSerializer to serialize a public field or public read/write property as XML text. |
| XmlType |
Obtém ou define um objeto que especifica como o XmlSerializer serializa uma classe à qual o XmlTypeAttribute foi aplicado.Gets or sets an object that specifies how the XmlSerializer serializes a class to which the XmlTypeAttribute has been applied. |
Métodos
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object. (Herdado de Object) |
| GetHashCode() |
Serve como a função de hash padrão.Serves as the default hash function. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual.Gets the Type of the current instance. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object. (Herdado de Object) |
| ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object. (Herdado de Object) |
Aplica-se a
Confira também
- XmlAttributeOverrides
- XmlSerializer
- XmlAttributes
- Apresentando a serialização XMLIntroducing XML Serialization
- Como especificar um nome de elemento alternativo para um fluxo XMLHow to: Specify an Alternate Element Name for an XML Stream
- Controlando a serialização XML usando atributosControlling XML Serialization Using Attributes
- Exemplos de Serialização XMLExamples of XML Serialization
- Ferramenta de Definição de Esquema XML (Xsd.exe)XML Schema Definition Tool (Xsd.exe)