XmlAnyElementAttribute Klas

Definitie

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

Overname

Object

Attribute

XmlAnyElementAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende voorbeeld wordt het XmlAnyElementAttribute toegepast op een veld met de naam AllElements dat een matrix met XmlElement objecten retourneert.

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

Opmerkingen

Gebruik de XmlAnyElementAttribute lijst met willekeurige gegevens (als XML-elementen) die kunnen worden verzonden als onderdeel van een XML-document, zoals metagegevens die als onderdeel van het document worden verzonden.

Pas het XmlAnyElementAttribute veld toe op een veld dat een matrix of XmlElementXmlNode objecten retourneert. Een dergelijk veld kan op twee manieren worden gebruikt, afhankelijk van of een object wordt geserialiseerd of gedeserialiseerd. Wanneer het object wordt geserialiseerd, wordt het gegenereerd als XML-elementen of knooppunten, ook al hebben ze geen corresponderend lid (of leden) in het object dat wordt geserialiseerd. Als u een Name eigenschapswaarde opgeeft bij het toepassen van het kenmerk, moeten alle XmlElement objecten die XmlNode in de matrix zijn ingevoegd, dezelfde elementnaam en standaardnaamruimte hebben, of er wordt een uitzondering gegenereerd. Als u de Namespace eigenschapswaarde instelt, moet u de Name eigenschap ook instellen en moeten de XmlElement of XmlNode objecten ook dezelfde naam- en naamruimtewaarden hebben. Als er geen Name waarde is opgegeven, kunnen de XmlElement objecten XmlNode een elementnaam hebben.

Wanneer u de Deserialize methode van de XmlSerializer klasse aanroept, worden alle elementen die geen corresponderend lid hebben in het object dat wordt gedeserialiseerd, verzameld in de matrix. Na deserialisatie doorloopt u de verzameling XmlElement items om de gegevens te verwerken. Als u een Name waarde opgeeft, bevat de matrix alleen XML-elementen met die naam. Als u geen Name waarde opgeeft, bevat de matrix alle elementen die geen corresponderend lid in de klasse hebben. Als een klasse meer dan één veld bevat waarop het kenmerk wordt toegepast, gebruikt u de Nameof Name en Namespace eigenschappen om onderscheid te maken tussen de inhoud van de matrices. Als een dergelijke klasse (met meerdere velden) ook één veld bevat waarvoor geen differentiërende eigenschapswaarden zijn ingesteld (met andere woorden Name , en Namespace) tijdens de deserialisatie, bevat deze matrix onbekende XML-elementen die nog niet zijn opgenomen in de andere matrices. Als een klasse meer dan één veld bevat dat geen differentiërende Namewaarde NameNamespace of waardeset heeft, wordt het gedrag tijdens deserialisatie niet opgegeven.

U kunt het XmlAnyElementAttribute veld ook toepassen op een veld dat één XmlElement object retourneert. Als u dit doet, moet u de eigenschappen en methoden van de XmlElement klasse gebruiken om de onbekende elementen recursief te herhalen.

U kunt meerdere exemplaren van de XmlAnyElementAttribute instantie toepassen op een klasselid, maar elke instantie moet een afzonderlijke Name eigenschapswaarde hebben. Als dezelfde Name eigenschap voor elk exemplaar is ingesteld, moet er voor elk exemplaar een afzonderlijke Namespace eigenschapswaarde worden ingesteld.

De UnknownNode gebeurtenissen en UnknownAttribute gebeurtenissen van de XmlSerializer items vinden niet plaats als u het XmlAnyElementAttribute toepast op een lid van een klasse.

Zie Kenmerken voor meer informatie over het gebruik van kenmerken.

Zie ook

• XmlAnyAttributeAttribute
• Inleiding tot XML-serialisatie