XmlAttributeAttribute XmlAttributeAttribute XmlAttributeAttribute XmlAttributeAttribute Class

Definition

Gibt an, dass XmlSerializer den Klassenmember als XML-Attribut serialisieren muss.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)]
[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]
public class XmlAttributeAttribute : Attribute
type XmlAttributeAttribute = class
    inherit Attribute
Public Class XmlAttributeAttribute
Inherits Attribute
Vererbung
XmlAttributeAttributeXmlAttributeAttributeXmlAttributeAttributeXmlAttributeAttribute
Attribute

Beispiele

Im folgende Beispiel wird eine Klasse, die mehrere Felder, die enthält serialisiert die XmlAttributeAttribute angewendet wird.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
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

Hinweise

Die XmlAttributeAttribute gehört zu einer Familie der Attribute, die steuert, wie die XmlSerializer Serialisieren bzw. Deserialisieren eines Objekts.The XmlAttributeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes, or deserializes, an object. Eine vollständige Liste ähnlicher Attribute, finden Sie unter Attributes, die Control XML Serialization.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Bei Anwendung auf ein öffentliches Feld oder eine Eigenschaft, die XmlAttributeAttribute informiert die XmlSerializer den Member als XML-Attribut serialisiert.When applied to a public field or property, the XmlAttributeAttribute informs the XmlSerializer to serialize the member as an XML attribute. In der Standardeinstellung die XmlSerializer serialisiert, öffentliche Felder und Eigenschaften als XML-Elemente.By default, the XmlSerializer serializes public fields and properties as XML elements.

Sie können Zuweisen der XmlAttributeAttribute können nur öffentliche Felder oder öffentliche Eigenschaften, die einen Wert (oder ein Array von Werten), die zurück auf einen der einfachen Typen zu XML Schema Definition Language (XSD) zugeordnet werden (einschließlich aller integrierten Datentypen aus der XSD- abgeleitetanySimpleTypeTyp).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). Die möglichen Typen enthalten, die die einfachen XSD-Typen, einschließlich zugeordnet werden können Guid, Char, und Enumerationen.The possible types include any that can be mapped to the XSD simple types, including Guid, Char, and enumerations. Finden Sie unter den DataType -Eigenschaft für eine Liste der XSD-Typen und deren zugeordnet.NET Datentypen.See the DataType property for a list of XSD types and how they are mapped to.NET data types.

Es gibt zwei spezielle Attribute, die mit festgelegt werden, können die XmlAttributeAttribute : die xml:lang (gibt die Sprache) und xml:space (gibt an, wie Leerraum behandelt) Attribute.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. Diese Attribute sollen Informationen übermitteln, die nur für eine Anwendung, die die XML-Verarbeitung relevant sind.These attributes are intended to convey information that is relevant only to an application processing the XML. Beispiele für diese Einstellung werden in den folgenden Code angezeigt.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  

Weitere Informationen zum Verwenden von Attributen finden Sie unter Attribute.For more information about using attributes, see Attributes.

Hinweis

Sie können das Wort XmlAttribute in Ihrem Code anstelle des längeren XmlAttributeAttribute.You can use the word XmlAttribute in your code instead of the longer XmlAttributeAttribute.

Konstruktoren

XmlAttributeAttribute() XmlAttributeAttribute() XmlAttributeAttribute() XmlAttributeAttribute()

Initialisiert eine neue Instanz der XmlAttributeAttribute-Klasse.Initializes a new instance of the XmlAttributeAttribute class.

XmlAttributeAttribute(String) XmlAttributeAttribute(String) XmlAttributeAttribute(String) XmlAttributeAttribute(String)

Initialisiert eine neue Instanz der XmlAttributeAttribute-Klasse und gibt den Namen des generierten XML-Attributs an.Initializes a new instance of the XmlAttributeAttribute class and specifies the name of the generated XML attribute.

XmlAttributeAttribute(String, Type) XmlAttributeAttribute(String, Type) XmlAttributeAttribute(String, Type) XmlAttributeAttribute(String, Type)

Initialisiert eine neue Instanz der XmlAttributeAttribute-Klasse.Initializes a new instance of the XmlAttributeAttribute class.

XmlAttributeAttribute(Type) XmlAttributeAttribute(Type) XmlAttributeAttribute(Type) XmlAttributeAttribute(Type)

Initialisiert eine neue Instanz der XmlAttributeAttribute-Klasse.Initializes a new instance of the XmlAttributeAttribute class.

Eigenschaften

AttributeName AttributeName AttributeName AttributeName

Ruft den Namen des XML-Attributs ab oder legt diesen fest.Gets or sets the name of the XML attribute.

DataType DataType DataType DataType

Ruft den XSD-Datentyp des vom XmlSerializer generierten XML-Attributs ab oder legt diesen fest.Gets or sets the XSD data type of the XML attribute generated by the XmlSerializer.

Form Form Form Form

Ruft einen Wert ab, der angibt, ob der von XmlSerializer generierte XML-Attributname gekennzeichnet ist, oder legt diesen fest.Gets or sets a value that indicates whether the XML attribute name generated by the XmlSerializer is qualified.

Namespace Namespace Namespace Namespace

Ruft den XML-Namespace des XML-Attributs ab oder legt diesen fest.Gets or sets the XML namespace of the XML attribute.

Type Type Type Type

Ruft den komplexen Typ des XML-Attributs ab oder legt diesen fest.Gets or sets the complex type of the XML attribute.

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Gilt für: