XmlAnyElementAttribute Klass

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

Arv

Object

Attribute

XmlAnyElementAttribute

Attribut

AttributeUsageAttribute

Exempel

Följande exempel gäller XmlAnyElementAttribute för ett fält med namnet AllElements som returnerar en matris med XmlElement objekt.

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

Kommentarer

Använd för XmlAnyElementAttribute att innehålla godtyckliga data (som XML-element) som kan skickas som en del av ett XML-dokument, till exempel metadata som skickas som en del av dokumentet.

Använd på XmlAnyElementAttribute ett fält som returnerar en matris med XmlElement eller XmlNode objekt. Ett sådant fält kan användas på två sätt, beroende på om ett objekt serialiseras eller deserialiseras. När objektet serialiseras genereras det som XML-element eller -noder, även om de inte har någon motsvarande medlem (eller medlemmar) i objektet som serialiseras. Om du anger ett Name egenskapsvärde när du tillämpar attributet måste alla XmlElement objekt eller XmlNode objekt som infogas i matrisen ha samma elementnamn och standardnamnområde, eller så genereras ett undantag. Om du anger egenskapsvärdet Namespace måste du också ange Name egenskapen och objekten XmlElement eller XmlNode måste också ha samma namn och namnområdesvärden. Om inget Name värde anges kan objekten XmlElement eller XmlNode ha valfritt elementnamn.

När du anropar Deserialize -metoden för XmlSerializer klassen samlas alla element som inte har någon motsvarande medlem i objektet som deserialiseras i matrisen. Efter deserialisering itererar du genom samlingen av XmlElement objekt för att bearbeta data. Om du anger ett Name värde innehåller matrisen endast XML-element med det namnet. Om du inte anger något Name värde innehåller matrisen alla element som inte har någon motsvarande medlem i klassen. Om en klass innehåller fler än ett fält som attributet tillämpas på använder du Nameegenskaperna , eller Name och Namespace för att skilja mellan innehållet i matriserna. Om en sådan klass (med flera fält) också innehåller ett fält som inte har några olika egenskapsvärden inställda (med andra ord Name , och Namespace) under deserialiseringen, innehåller den här matrisen alla okända XML-element som inte redan finns i de andra matriserna. Om en klass innehåller mer än ett fält som inte har en differentierings Name- eller NameNamespace värdeuppsättning är beteendet under deserialiseringen ospecificerat.

Du kan också använda för XmlAnyElementAttribute ett fält som returnerar ett enda XmlElement objekt. Om du gör det måste du använda egenskaperna och metoderna för XmlElement klassen för att rekursivt iterera genom de okända elementen.

Du kan tillämpa flera instanser av på XmlAnyElementAttribute en klassmedlem, men varje instans måste ha ett distinkt Name egenskapsvärde. Om samma Name egenskap har angetts för varje instans måste ett distinkt Namespace egenskapsvärde anges för varje instans.

Händelserna UnknownNode och UnknownAttributeXmlSerializer inträffar inte om du tillämpar på XmlAnyElementAttribute en medlem i en klass.

Mer information om hur du använder attribut finns i Attribut.

Se även

• XmlAnyAttributeAttribute
• Introduktion till XML-serialisering