XmlAnyElementAttribute Klasse

Definition

Namespace:

System.Xml.Serialization

Assembly:

System.Xml.ReaderWriter.dll

Quelle:

XmlAnyElementAttribute.cs

Gibt an, dass der Member (ein Feld, das ein Array von XmlElement-Objekten oder XmlNode-Objekten zurückgibt) Objekte enthält, die XML-Elemente darstellen, die keine entsprechenden Member in dem zu serialisierenden oder zu deserialisierenden Objekt aufweisen.

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 auf XmlAnyElementAttribute ein Feld mit dem Namen AllElements angewendet, das ein Array von XmlElement Objekten zurückgibt.

public ref class XClass
{
public:

   /* Apply the XmlAnyElementAttribute to a field returning an array
      of XmlElement objects. */

   [XmlAnyElement]
   array<XmlElement^>^AllElements;
};

public ref class Test
{
public:
   void DeserializeObject( String^ filename )
   {
      // Create an XmlSerializer.
      XmlSerializer^ mySerializer = gcnew XmlSerializer( XClass::typeid );

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

      // Deserialize the class.
      XClass^ x = dynamic_cast<XClass^>(mySerializer->Deserialize( fs ));

      // Read the element names and values.
      System::Collections::IEnumerator^ myEnum = x->AllElements->GetEnumerator();
      while ( myEnum->MoveNext() )
      {
         XmlElement^ xel = safe_cast<XmlElement^>(myEnum->Current);
         Console::WriteLine( "{0}: {1}", xel->LocalName, xel->Value );
      }
   }
};

int main()
{
   Test^ t = gcnew Test;
   t->DeserializeObject( "XFile.xml" );
}

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

Tipp

Wenn Sie in einer portablen Klassenbibliothek arbeiten, z. B. in Silverlight, Windows Phone oder Windows Store-App-Projekt, und verwenden Sie die .NET Framework 4.0.3 und höher, oder XElementXNode anstelle von XmlElement und XmlNode.

Verwenden Sie die XmlAnyElementAttribute , um 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 den XmlAnyElementAttribute 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 der Serialisierung wird das Objekt als XML-Elemente oder -Knoten generiert, obwohl es keinen entsprechenden Member (oder Member) im zu serialisierten Objekt aufweist. Wenn Sie beim Anwenden des Attributs einen Name Eigenschaftswert angeben, müssen alle XmlElement oder XmlNode objekte, die in das Array eingefügt werden, denselben Elementnamen und denselben Standardnamespace aufweisen, sonst wird eine Ausnahme ausgelöst. Wenn Sie den Namespace Eigenschaftswert festlegen, müssen Sie auch die Name -Eigenschaft festlegen, und die XmlElement -Objekte oder XmlNode müssen auch denselben Namen und denselben Namespacewert aufweisen. Wenn kein Name Wert angegeben ist, können die XmlElement -Objekte oder XmlNode einen beliebigen Elementnamen aufweisen.

Wenn Sie die Deserialize -Methode der XmlSerializer -Klasse aufrufen, werden alle Elemente, die nicht über einen entsprechenden Member im Objekt verfügen, das deserialisiert wird, im Array gesammelt. Durchlaufen Sie nach der Deserialisierung 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 keinen entsprechenden Member in der Klasse aufweisen. Wenn eine Klasse mehr als ein Feld enthält, auf das das Attribut angewendet wird, verwenden Sie die NameEigenschaften oder Name und Namespace , um zwischen den Inhalten der Arrays zu unterscheiden. Wenn eine solche Klasse (mit mehreren Feldern) auch ein Feld enthält, für das während der Deserialisierung keine differenzierenden Eigenschaftswerte festgelegt sind (also Name und Namespace), enthält dieses Array alle unbekannten XML-Elemente, die nicht bereits in den anderen Arrays enthalten sind. Wenn eine Klasse mehr als ein Feld enthält, für das kein differenzierendes Name- oder Name - und Namespace -wert festgelegt ist, ist das Verhalten während der Deserialisierung nicht angegeben.

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

Sie können mehrere Instanzen von XmlAnyElementAttribute auf einen Klassenmember anwenden, aber jede instance muss über einen eindeutigen Name Eigenschaftswert verfügen. Oder, wenn für jede instance dieselbe Name Eigenschaft festgelegt ist, muss für jeden instance ein unterschiedlicher Namespace Eigenschaftswert festgelegt werden.

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

Hinweis

Sie können das Wort XmlAnyElement im Code anstelle des längeren XmlAnyElementAttributeverwenden.

Weitere Informationen zur Verwendung von Attributen finden Sie unter Attribute.

Konstruktoren

XmlAnyElementAttribute()	Initialisiert eine neue Instanz der XmlAnyElementAttribute-Klasse.
XmlAnyElementAttribute(String)	Initialisiert eine neue Instanz der XmlAnyElementAttribute-Klasse und gibt den im XML-Dokument generierten XML-Elementnamen an.
XmlAnyElementAttribute(String, String)	Initialisiert eine neue Instanz der XmlAnyElementAttribute-Klasse und gibt den im XML-Dokument und dessen XML-Namespace generierten XML-Elementnamen an.

Eigenschaften

Name	Ruft den XML-Elementnamen ab oder legt diesen fest.
Namespace	Ruft den im XML-Dokument generierten XML-Namespace ab oder legt diesen fest.
Order	Ruft die explizite Reihenfolge ab, in der die Elemente serialisiert oder deserialisiert werden, oder legt diese fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• XmlAnyAttributeAttribute
• Einführung in die XML-Serialisierung