Freigeben über

XmlAttributes.XmlAttribute-Eigenschaft

Ruft ein Objekt ab, das angibt, wie XmlSerializer ein öffentliches Feld oder eine öffentliche Lese-/Schreibeigenschaft als XML-Attribut serialisiert, oder legt dieses fest.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

Syntax

'Declaration
Public Property XmlAttribute As XmlAttributeAttribute
'Usage
Dim instance As XmlAttributes
Dim value As XmlAttributeAttribute

value = instance.XmlAttribute

instance.XmlAttribute = value

public XmlAttributeAttribute XmlAttribute { get; set; }

public:
property XmlAttributeAttribute^ XmlAttribute {
    XmlAttributeAttribute^ get ();
    void set (XmlAttributeAttribute^ value);
}

/** @property */
public XmlAttributeAttribute get_XmlAttribute ()

/** @property */
public void set_XmlAttribute (XmlAttributeAttribute value)

public function get XmlAttribute () : XmlAttributeAttribute

public function set XmlAttribute (value : XmlAttributeAttribute)

Eigenschaftenwert

Ein XmlAttributeAttribute, das die Serialisierung eines öffentlichen Felds oder einer Lese-/Schreibeigenschaft als XML-Attribut steuert.

Hinweise

In der Standardeinstellung werden öffentliche Felder bzw. öffentliche Lese-/Schreibeigenschaften als XML-Elemente serialisiert, wenn ihnen kein Attribut zugewiesen wurde. XmlSerializer kann jedoch angewiesen werden, ein XML-Attribut zu generieren, indem Sie dem Feld oder der Eigenschaft ein XmlAttributeAttribute zuweisen.

Mit der XmlAttribute-Eigenschaft haben Sie die Möglichkeit, sowohl die Standardserialisierung als auch die gesteuerte Serialisierung zu überschreiben, indem Sie dem Member ein XmlAttributeAttribute zuweisen. Hierzu erstellen Sie ein XmlAttributeAttribute und legen dessen Eigenschaften fest (z. B. AttributeName). Weisen Sie das neue Objekt der XmlAttribute-Eigenschaft eines XmlAttributes-Objekts zu. Fügen Sie das XmlAttributes-Objekt einem XmlAttributeOverrides-Objekt hinzu, und geben Sie dabei den Typ des Objekts, das das Feld oder die Eigenschaft enthält, sowie den Namen des Felds oder der Eigenschaft an. Erstellen Sie abschließend mithilfe des XmlAttributeOverrides-Objekts einen XmlSerializer, und rufen Sie die Serialize-Methode oder die Deserialize-Methode auf.

Beispiel

Im folgenden Beispiel wird die Klasse Group erstellt, die die Eigenschaft GroupName enthält. Die GroupName-Eigenschaft wird als XML-Attribut serialisiert. Im Beispiel wird ein XmlAttributeOverrides-Objekt und ein XmlAttributes-Objekt erstellt, mit denen die Standardserialisierung des Felds überschrieben wird. Anschließend wird ein XmlAttributeAttribute erstellt, um nur die Eigenschaft zu überschreiben, und das Objekt auf die XmlAttribute-Eigenschaft festgelegt. Das XmlAttributes-Objekt wird dem XmlAttributeOverrides-Objekt hinzugefügt, wobei der Name des überschriebenen Members angegeben wird. Zum Schluss wird XmlSerializer erstellt und zurückgegeben. Dies geschieht mithilfe des XmlAttributeOverrides-Objekts.

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


' This is the class that will be serialized.
Public Class Group
    ' This is the attribute that will be overridden.
    <XmlAttribute()> Public GroupName As String
    Public GroupNumber As Integer
End Class


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("OverrideAttribute.xml")
        test.DeserializeObject("OverrideAttribute.xml")
    End Sub
    
    ' Return an XmlSerializer used for overriding. 
    Public Function CreateOverrider() As XmlSerializer
        ' Create the XmlAttributeOverrides and XmlAttributes objects.
        Dim xOver As New XmlAttributeOverrides()
        Dim xAttrs As New XmlAttributes()
        
        ' Create an overriding XmlAttributeAttribute set it to
        ' the XmlAttribute property of the XmlAttributes object.
        Dim xAttribute As New XmlAttributeAttribute("SplinterName")
        xAttrs.XmlAttribute = xAttribute
        
        ' Add to the XmlAttributeOverrides. Specify the member name.
        xOver.Add(GetType(Group), "GroupName", xAttrs)
        
        ' Create the XmlSerializer and return it.
        Return New XmlSerializer(GetType(Group), xOver)
    End Function 'CreateOverrider
    
    
    Public Sub SerializeObject(ByVal filename As String)
        ' Create an instance of the XmlSerializer class.
        Dim mySerializer As XmlSerializer = CreateOverrider()
        ' 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 Name property, which will be generated
        ' as an XML attribute. 
        myGroup.GroupName = ".NET"
        myGroup.GroupNumber = 1
        ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myGroup)
        writer.Close()
    End Sub
    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim mySerializer As XmlSerializer = CreateOverrider()
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim myGroup As Group = CType(mySerializer.Deserialize(fs), Group)

        Console.WriteLine(myGroup.GroupName)
        Console.WriteLine(myGroup.GroupNumber)
    End Sub
End Class

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

// This is the class that will be serialized.
public class Group
{
   // This is the attribute that will be overridden.
   [XmlAttribute]
   public string GroupName;
   public int GroupNumber;
}
 
public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeObject("OverrideAttribute.xml");
      test.DeserializeObject("OverrideAttribute.xml");
   }
   // Return an XmlSerializer used for overriding. 
   public XmlSerializer CreateOverrider()
   {
      // Create the XmlAttributeOverrides and XmlAttributes objects.
      XmlAttributeOverrides xOver = new XmlAttributeOverrides();
      XmlAttributes xAttrs = new XmlAttributes();

      /* Create an overriding XmlAttributeAttribute set it to 
      the XmlAttribute property of the XmlAttributes object.*/
      XmlAttributeAttribute xAttribute = new XmlAttributeAttribute("SplinterName");
      xAttrs.XmlAttribute = xAttribute;

      // Add to the XmlAttributeOverrides. Specify the member name.
      xOver.Add(typeof(Group), "GroupName", xAttrs);

      // Create the XmlSerializer and return it.
      return new XmlSerializer(typeof(Group), xOver);
   }
 
   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =  CreateOverrider();
      // 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 Name property, which will be generated 
      as an XML attribute. */
      myGroup.GroupName = ".NET";
      myGroup.GroupNumber = 1;
      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
       writer.Close();
   }

   public void DeserializeObject(string filename)
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Group myGroup = (Group) 
      mySerializer.Deserialize(fs);
      
      Console.WriteLine(myGroup.GroupName);
      Console.WriteLine(myGroup.GroupNumber);
   }
}
   

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

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

// This is the class that will be serialized.
public ref class Group
{
public:

   // This is the attribute that will be overridden.

   [XmlAttributeAttribute]
   String^ GroupName;
   int GroupNumber;
};

// Return an XmlSerializer used for overriding. 
XmlSerializer^ CreateOverrider()
{
   // Create the XmlAttributeOverrides and XmlAttributes objects.
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;
   XmlAttributes^ xAttrs = gcnew XmlAttributes;

   /* Create an overriding XmlAttributeAttribute set it to 
      the XmlAttribute property of the XmlAttributes object.*/
   XmlAttributeAttribute^ xAttribute = gcnew XmlAttributeAttribute( "SplinterName" );
   xAttrs->XmlAttribute = xAttribute;

   // Add to the XmlAttributeOverrides. Specify the member name.
   xOver->Add( Group::typeid, "GroupName", xAttrs );

   // Create the XmlSerializer and return it.
   return gcnew XmlSerializer( Group::typeid,xOver );
}

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

   // 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 Name property, which will be generated 
      as an XML attribute. */
   myGroup->GroupName = ".NET";
   myGroup->GroupNumber = 1;

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

void DeserializeObject( String^ filename )
{
   XmlSerializer^ mySerializer = CreateOverrider();
   FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
   Group^ myGroup = dynamic_cast<Group^>(mySerializer->Deserialize( fs ));
   Console::WriteLine( myGroup->GroupName );
   Console::WriteLine( myGroup->GroupNumber );
}

int main()
{
   SerializeObject( "OverrideAttribute.xml" );
   DeserializeObject( "OverrideAttribute.xml" );
}

import System.*;
import System.IO.*;
import System.Xml.*;
import System.Xml.Serialization.*;

// This is the class that will be serialized.
public class Group
{
    // This is the attribute that will be overridden.
    /** @attribute XmlAttribute()
     */
    public String groupName;
    public int groupNumber;
} //Group

public class Run
{
    public static void main(String[] args)
    {
        Run test = new Run();
        test.SerializeObject("OverrideAttribute.xml");
        test.DeserializeObject("OverrideAttribute.xml");
    } //main

    // Return an XmlSerializer used for overriding. 
    public XmlSerializer CreateOverrider()
    {
        // Create the XmlAttributeOverrides and XmlAttributes objects.
        XmlAttributeOverrides xOver = new XmlAttributeOverrides();
        XmlAttributes xAttrs = new XmlAttributes();

        /* Create an overriding XmlAttributeAttribute set it to 
           the XmlAttribute property of the XmlAttributes object.*/
        XmlAttributeAttribute xAttribute =
            new XmlAttributeAttribute("SplinterName");
        xAttrs.set_XmlAttribute(xAttribute);

        // Add to the XmlAttributeOverrides. Specify the member name.
        xOver.Add(Group.class.ToType(), "groupName", xAttrs);

        // Create the XmlSerializer and return it.
        return new XmlSerializer(Group.class.ToType(), xOver);
    } //CreateOverrider

    public void SerializeObject(String fileName)
    {
        // Create an instance of the XmlSerializer class.
        XmlSerializer mySerializer = CreateOverrider();

        // 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 Name property, which will be generated 
           as an XML attribute. */
        myGroup.groupName = ".NET";
        myGroup.groupNumber = 1;

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

    public void DeserializeObject(String fileName)
    {
        XmlSerializer mySerializer = CreateOverrider();
        FileStream fs = new FileStream(fileName, FileMode.Open);
        Group myGroup = (Group)mySerializer.Deserialize(fs);

        Console.WriteLine(myGroup.groupName);
        Console.WriteLine(myGroup.groupNumber);
    } //DeserializeObject
} //Run

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0

Siehe auch

Referenz

XmlAttributes-Klasse
XmlAttributes-Member
System.Xml.Serialization-Namespace

  • Last updated on