XmlAttributeAttribute Classe

Definição

Especifica que o XmlSerializer deve serializar o membro de classe como um atributo XML.Specifies that the XmlSerializer must serialize the class member as an XML attribute.

public ref class XmlAttributeAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlAttributeAttribute : Attribute
type XmlAttributeAttribute = class
    inherit Attribute
Public Class XmlAttributeAttribute
Inherits Attribute
Herança
XmlAttributeAttribute
Atributos

Exemplos

O exemplo a seguir serializa uma classe que contém vários campos aos quais a XmlAttributeAttribute é aplicada.The following example serializes a class that contains several fields to which the XmlAttributeAttribute is applied.

#using <System.Xml.dll>
#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;
using namespace System::Xml::Schema;

public ref class Group
{
public:

   [XmlAttributeAttribute(Namespace="http://www.cpandl.com")]
   String^ GroupName;

   [XmlAttributeAttribute(DataType="base64Binary")]
   array<Byte>^GroupNumber;

   [XmlAttributeAttribute(DataType="date",AttributeName="CreationDate")]
   DateTime Today;
};

void SerializeObject( String^ filename )
{
   // Create an instance of the XmlSerializer class.
   XmlSerializer^ mySerializer = gcnew XmlSerializer( Group::typeid );

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

   // Create an instance of the class that will be serialized.
   Group^ myGroup = gcnew Group;

   // Set the object properties.
   myGroup->GroupName = ".NET";
   array<Byte>^hexByte = {Convert::ToByte( 100 ),Convert::ToByte( 50 )};
   myGroup->GroupNumber = hexByte;
   DateTime myDate = DateTime(2001,1,10);
   myGroup->Today = myDate;

   // Serialize the class, and close the TextWriter.
   mySerializer->Serialize( writer, myGroup );
   writer->Close();
}

int main()
{
   SerializeObject( "Attributes.xml" );
}
using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;

public class Group
{
   [XmlAttribute (Namespace = "http://www.cpandl.com")]
   public string GroupName;
   
   [XmlAttribute(DataType = "base64Binary")]
   public Byte [] GroupNumber;

   [XmlAttribute(DataType = "date", AttributeName = "CreationDate")]
   public DateTime Today;
}

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

   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  
      new XmlSerializer(typeof(Group));

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

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Set the object properties.
      myGroup.GroupName = ".NET";

      Byte [] hexByte = new Byte[2]{Convert.ToByte(100),
      Convert.ToByte(50)};
      myGroup.GroupNumber = hexByte;

      DateTime myDate = new DateTime(2001,1,10);
      myGroup.Today = myDate;

      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
       writer.Close();
   }
}
   
Option Explicit
Option Strict

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


Public Class Group
    <XmlAttribute(Namespace := "http://www.cpandl.com")> _
        Public GroupName As String    
    <XmlAttribute(DataType := "base64Binary")> _
        Public GroupNumber() As Byte    
    <XmlAttribute(DataType := "date", AttributeName := "CreationDate")> _
        Public Today As DateTime
End Class

Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("Attributes.xml")
    End Sub 
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As New XmlSerializer(GetType(Group))
        
        ' Writing the file requires a TextWriter.
        Dim writer As New StreamWriter(filename)
        
        ' Create an instance of the class that will be serialized.
        Dim myGroup As New Group()
        
        ' Set the object properties.
        myGroup.GroupName = ".NET"
        
        Dim hexByte() As Byte = {Convert.ToByte(100), Convert.ToByte(50)}
        myGroup.GroupNumber = hexByte
        
        Dim myDate As New DateTime(2001, 1, 10)
        myGroup.Today = myDate
        
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
End Class

Comentários

O XmlAttributeAttribute pertence a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto.The XmlAttributeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes, or deserializes, an object. Para obter uma lista completa de atributos semelhantes, consulte atributos que controlam a serialização de XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Quando aplicado a um campo público ou propriedade, o XmlAttributeAttribute informa ao XmlSerializer para serializar o membro como um atributo XML.When applied to a public field or property, the XmlAttributeAttribute informs the XmlSerializer to serialize the member as an XML attribute. Por padrão, o XmlSerializer serializa campos públicos e propriedades como elementos XML.By default, the XmlSerializer serializes public fields and properties as XML elements.

Você pode atribuir a XmlAttributeAttribute somente a campos públicos ou propriedades públicas que retornam um valor (ou uma matriz de valores) que podem ser mapeados para um dos tipos simples XSD (linguagem de definição de esquema XML) (incluindo todos os tipos de texto internos derivados do tipo de anySimpleType XSD).You can assign the XmlAttributeAttribute only to public fields or public properties that return a value (or array of values) that can be mapped to one of the XML Schema definition language (XSD) simple types (including all built-in datatypes derived from the XSD anySimpleType type). Os tipos possíveis incluem qualquer um que possa ser mapeado para os tipos simples XSD, incluindo Guid, Chare enumerações.The possible types include any that can be mapped to the XSD simple types, including Guid, Char, and enumerations. Consulte a propriedade DataType para obter uma lista de tipos XSD e como eles são mapeados tipos de dados to.NET.See the DataType property for a list of XSD types and how they are mapped to.NET data types.

Há dois atributos especiais que podem ser definidos com o XmlAttributeAttribute: o xml:lang (especifica o idioma) e xml:space (especifica como lidar com espaços em branco).There are two special attributes that can be set with the XmlAttributeAttribute : the xml:lang (specifies language) and xml:space (specifies how to handle white space) attributes. Esses atributos destinam-se a transmitir informações que são relevantes apenas para um aplicativo que processa o XML.These attributes are intended to convey information that is relevant only to an application processing the XML. Exemplos de configuração são mostrados no código a seguir.Examples of setting these are shown in the following code.

[XmlAttribute("xml:lang")]  
 public string Lang;  
 // Set this to 'default' or 'preserve'.  
 [XmlAttribute("space",   
 Namespace = "http://www.w3.org/XML/1998/namespace")]  
 public string Space 
<XmlAttribute("xml:lang")> _  
Public Lang As String   
' Set this to 'default' or 'preserve'.  
<XmlAttribute("space", _  
Namespace:= "http://www.w3.org/XML/1998/namespace")> _  
Public Space As String  

Para obter mais informações sobre como usar atributos, consulte atributos.For more information about using attributes, see Attributes.

Observação

Você pode usar a palavra XmlAttribute em seu código em vez da XmlAttributeAttributemais longa.You can use the word XmlAttribute in your code instead of the longer XmlAttributeAttribute.

Construtores

XmlAttributeAttribute()

Inicializa uma nova instância da classe XmlAttributeAttribute.Initializes a new instance of the XmlAttributeAttribute class.

XmlAttributeAttribute(String)

Inicializa uma nova instância da classe XmlAttributeAttribute e especifica o nome do atributo XML gerado.Initializes a new instance of the XmlAttributeAttribute class and specifies the name of the generated XML attribute.

XmlAttributeAttribute(String, Type)

Inicializa uma nova instância da classe XmlAttributeAttribute.Initializes a new instance of the XmlAttributeAttribute class.

XmlAttributeAttribute(Type)

Inicializa uma nova instância da classe XmlAttributeAttribute.Initializes a new instance of the XmlAttributeAttribute class.

Propriedades

AttributeName

Obtém ou define o nome do atributo XML.Gets or sets the name of the XML attribute.

DataType

Obtém ou define o tipo de dados XSD do atributo XML gerado pelo XmlSerializer.Gets or sets the XSD data type of the XML attribute generated by the XmlSerializer.

Form

Obtém ou define um valor que indica se o nome do atributo XML gerado pelo XmlSerializer é qualificado.Gets or sets a value that indicates whether the XML attribute name generated by the XmlSerializer is qualified.

Namespace

Obtém ou define o namespace de XML do atributo XML.Gets or sets the XML namespace of the XML attribute.

Type

Obtém ou define o tipo complexo do atributo XML.Gets or sets the complex type of the XML attribute.

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para a instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Herdado de Attribute)
Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
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)

Implantações explícitas de interface

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a