XmlAnyElementAttribute Klasse

Definition

public ref class XmlAnyElementAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, AllowMultiple=true)]
public class XmlAnyElementAttribute : Attribute

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

Public Class XmlAnyElementAttribute
Inherits Attribute

Vererbung

Object

Attribute

XmlAnyElementAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird das XmlAnyElementAttribute Feld AllElements angewendet, das ein Array von XmlElement Objekten zurückgibt.

public class XClass
{
   /* Apply the XmlAnyElementAttribute to a field returning an array
   of XmlElement objects. */
   [XmlAnyElement]
   public XmlElement[] AllElements;
}

public class Test
{
   public static void Main()
   {
      Test t = new Test();
      t.DeserializeObject("XFile.xml");
   }

   private void DeserializeObject(string filename)
   {
      // Create an XmlSerializer.
      XmlSerializer mySerializer = new XmlSerializer(typeof(XClass));

      // To read a file, a FileStream is needed.
      FileStream fs = new FileStream(filename, FileMode.Open);

      // Deserialize the class.
      XClass x = (XClass) mySerializer.Deserialize(fs);

      // Read the element names and values.
      foreach(XmlElement xel in x.AllElements)
         Console.WriteLine(xel.LocalName + ": " + xel.Value);
   }
}

Public Class XClass
    ' Apply the XmlAnyElementAttribute to a field returning an array
    ' of XmlElement objects.
    <XmlAnyElement()> Public AllElements() As XmlElement
End Class


Public Class Test
    
    Public Shared Sub Main()
        Dim t As New Test()
        t.DeserializeObject("XFile.xml")
    End Sub
    
    
    Private Sub DeserializeObject(filename As String)
        ' Create an XmlSerializer.
        Dim mySerializer As New XmlSerializer(GetType(XClass))
        
        ' To read a file, a FileStream is needed.
        Dim fs As New FileStream(filename, FileMode.Open)
        
        ' Deserialize the class.
        Dim x As XClass = CType(mySerializer.Deserialize(fs), XClass)
        
        ' Read the element names and values.
        Dim xel As XmlElement
        For Each xel In  x.AllElements
            Console.WriteLine((xel.LocalName & ": " & xel.Value))
        Next xel
    End Sub
End Class

Hinweise

Verwenden Sie die XmlAnyElementAttribute Möglichkeit, beliebige Daten (als XML-Elemente) zu enthalten, die als Teil eines XML-Dokuments gesendet werden können, z. B. Metadaten, die als Teil des Dokuments gesendet werden.

Wenden Sie das XmlAnyElementAttribute Feld auf ein Feld an, das ein Array von XmlElement oder XmlNode Objekten zurückgibt. Ein solches Feld kann auf zwei Arten verwendet werden, je nachdem, ob ein Objekt serialisiert oder deserialisiert wird. Bei serialisierter Serialisierung wird das Objekt als XML-Elemente oder Knoten generiert, auch wenn es kein entsprechendes Element (oder member) im serialisierten Objekt gibt. Wenn Sie beim Anwenden des Attributs einen Name Eigenschaftswert angeben, müssen alle XmlElement oder XmlNode Objekte, die in das Array eingefügt wurden, denselben Elementnamen und den Standardnamespace aufweisen, oder eine Ausnahme wird ausgelöst. Wenn Sie den Namespace Eigenschaftswert festlegen, müssen Sie auch die Name Eigenschaft festlegen, und die oder XmlNode die XmlElement Objekte müssen auch denselben Namen und Namespacewerte aufweisen. Wenn kein Name Wert angegeben ist, können die XmlElement Objekte XmlNode einen beliebigen Elementnamen aufweisen.

Wenn Sie die Deserialize Methode der XmlSerializer Klasse aufrufen, werden alle Elemente, die nicht über ein entsprechendes Element im Objekt verfügen, das deserialisiert wird, im Array erfasst. Nach der Deserialisierung durchlaufen Sie die Sammlung von XmlElement Elementen, um die Daten zu verarbeiten. Wenn Sie einen Name Wert angeben, enthält das Array nur XML-Elemente mit diesem Namen. Wenn Sie keinen Wert angeben Name , enthält das Array alle Elemente, die kein entsprechendes Element in der Klasse aufweisen. Wenn eine Klasse mehrere Felder enthält, auf die das Attribut angewendet wird, verwenden Sie die Nameoder NameNamespace die Eigenschaften, um zwischen dem Inhalt der Arrays zu unterscheiden. Wenn eine solche Klasse (mit mehreren Feldern) auch ein Feld enthält, das keine abweichenden Eigenschaftswerte (mit anderen Worten Name , und Namespace) während der Deserialisierung enthält, enthält dieses Array alle unbekannten XML-Elemente, die noch nicht in den anderen Arrays enthalten sind. Wenn eine Klasse mehr als ein Feld enthält, das keine unterscheidungs- Nameoder NameNamespace Wertsätze aufweist, wird das Verhalten während der Deserialisierung nicht angegeben.

Sie können das XmlAnyElementAttribute Feld auch auf ein Feld anwenden, das ein einzelnes XmlElement Objekt zurückgibt. In diesem Fall müssen Sie die Eigenschaften und Methoden der XmlElement Klasse verwenden, um die unbekannten Elemente rekursiv zu durchlaufen.

Sie können mehrere Instanzen der XmlAnyElementAttribute Klasse auf ein Klassenelement anwenden, aber jede Instanz muss über einen eindeutigen Name Eigenschaftswert verfügen. Wenn die gleiche Name Eigenschaft für jede Instanz festgelegt wird, muss für jede Instanz ein eindeutiger Namespace Eigenschaftswert festgelegt werden.

Die UnknownNode Ereignisse UnknownAttribute und Ereignisse der XmlSerializer Klasse treten nicht auf, wenn Sie das XmlAnyElementAttribute Element einer Klasse anwenden.

Weitere Informationen zur Verwendung von Attributen finden Sie unter "Attribute".

Weitere Informationen

• XmlAnyAttributeAttribute
• Einführung in die XML-Serialisierung