XmlAttributeAttribute Clase

Definición

Espacio de nombres:

System.Xml.Serialization

Ensamblado:

System.Xml.ReaderWriter.dll

Source:

XmlAttributeAttribute.cs

Especifica que XmlSerializer debe serializar el miembro de la clase como un atributo XML.

public ref class XmlAttributeAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlAttributeAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)>]
type XmlAttributeAttribute = class
    inherit Attribute

Public Class XmlAttributeAttribute
Inherits Attribute

Herencia

Object

Attribute

XmlAttributeAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente se serializa una clase que contiene varios campos a los que se aplica .XmlAttributeAttribute

#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

Comentarios

XmlAttributeAttribute pertenece a una familia de atributos que controla cómo XmlSerializer serializa, o deserializa, un objeto . Para obtener una lista completa de atributos similares, vea Atributos que controlan la serialización XML.

Cuando se aplica a un campo o propiedad público, informa XmlAttributeAttribute a para XmlSerializer serializar el miembro como un atributo XML. De forma predeterminada, serializa XmlSerializer los campos públicos y las propiedades como elementos XML.

Puede asignar los XmlAttributeAttribute únicos a campos públicos o propiedades públicas que devuelven un valor (o matriz de valores) que se puede asignar a uno de los tipos simples del lenguaje de definición de esquema XML (XSD), incluidos todos los tipos de datos integrados derivados del tipo XSD anySimpleType . Los tipos posibles incluyen cualquiera que se pueda asignar a los tipos simples XSD, incluidas Guidlas enumeraciones , Chary . Consulte la DataType propiedad para obtener una lista de tipos XSD y cómo se asignan to.NET tipos de datos.

Hay dos atributos especiales que se pueden establecer con XmlAttributeAttribute : el xml:lang (especifica el idioma) y xml:space (especifica cómo controlar los atributos de espacio en blanco). Estos atributos están diseñados para transmitir información que solo es relevante para una aplicación que procesa el XML. Algunos ejemplos de configuración se muestran en el código siguiente.

[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 obtener más información sobre el uso de atributos, vea Atributos.

Nota:

Puede usar la palabra XmlAttribute en el código en lugar de XmlAttributeAttribute.

Constructores

XmlAttributeAttribute()	Inicializa una nueva instancia de la clase XmlAttributeAttribute.
XmlAttributeAttribute(String)	Inicializa una nueva instancia de la clase XmlAttributeAttribute y especifica el nombre del atributo XML generado.
XmlAttributeAttribute(String, Type)	Inicializa una nueva instancia de la clase XmlAttributeAttribute.
XmlAttributeAttribute(Type)	Inicializa una nueva instancia de la clase XmlAttributeAttribute.

Propiedades

AttributeName	Obtiene o establece el nombre del atributo XML.
DataType	Obtiene o establece el tipo de datos XSD del atributo XML generado por XmlSerializer.
Form	Obtiene o establece un valor que indica si está calificado el nombre del atributo XML generado por XmlSerializer.
Namespace	Obtiene o establece el espacio de nombres XML del atributo XML.
Type	Obtiene o establece el tipo complejo del atributo XML.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)