XmlSerializer.UnknownElement Ereignis

Definition

Namespace:
System.Xml.Serialization
Assemblys:
netstandard.dll, System.Xml.XmlSerializer.dll
Assembly:
System.Xml.XmlSerializer.dll
Assembly:
System.Xml.dll
Assembly:
netstandard.dll
Quelle:
XmlSerializer.cs
Quelle:
XmlSerializer.cs
Quelle:
XmlSerializer.cs
Quelle:
XmlSerializer.cs
Quelle:
XmlSerializer.cs

Tritt auf, wenn während der XmlSerializer Deserialisierung ein XML-Element mit unbekanntem Typ auftritt.

public:
 event System::Xml::Serialization::XmlElementEventHandler ^ UnknownElement;
public event System.Xml.Serialization.XmlElementEventHandler UnknownElement;
member this.UnknownElement : System.Xml.Serialization.XmlElementEventHandler 
Public Custom Event UnknownElement As XmlElementEventHandler

Ereignistyp

XmlElementEventHandler

Beispiele

Im folgenden Beispiel wird eine Klasse, die aus einer Datei mit dem Namen UnknownElements.xmlbenannt Group ist, deserialisiert. Wenn ein Element in der Datei gefunden wird, das kein entsprechendes Element in der Klasse enthält, tritt das UnknownElement Ereignis auf. Zum Testen des Beispiels fügen Sie den folgenden XML-Code in eine Datei mit dem Namen UnknownElements.xmlein.

<?xml version="1.0" encoding="utf-8"?>
<Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GroupName>MyGroup</GroupName>
  <GroupSize>Large</GroupSize>
  <GroupNumber>444</GroupNumber>
  <GroupBase>West</GroupBase>
</Group>

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

public class Group{
   public string GroupName;
}

public class Test{
   static void Main(){
      Test t = new Test();
      // Deserialize the file containing unknown elements.
      t.DeserializeObject("UnknownElements.xml");
   }
   private void Serializer_UnknownElement(object sender, XmlElementEventArgs e){
      Console.WriteLine("Unknown Element");
      Console.WriteLine("\t" + e.Element.Name + " " + e.Element.InnerXml);
      Console.WriteLine("\t LineNumber: " + e.LineNumber);
      Console.WriteLine("\t LinePosition: " + e.LinePosition);
      
      Group x  = (Group) e.ObjectBeingDeserialized;
      Console.WriteLine (x.GroupName);
      Console.WriteLine (sender.ToString());
   }
   private void DeserializeObject(string filename){
      XmlSerializer ser = new XmlSerializer(typeof(Group));
      // Add a delegate to handle unknown element events.
      ser.UnknownElement+=new XmlElementEventHandler(Serializer_UnknownElement);
      // A FileStream is needed to read the XML document.
     FileStream fs = new FileStream(filename, FileMode.Open);
     Group g = (Group) ser.Deserialize(fs);
     fs.Close();
    }
}

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

Public Class Group
   Public GroupName As String 
End Class

Public Class Test
   Shared Sub Main()
      Dim t As Test = new Test()
      ' Deserialize the file containing unknown elements.
      t.DeserializeObject("UnknownElements.xml")
   End Sub

   Private Sub Serializer_UnknownElement _
   (sender As Object , e As XmlElementEventArgs)
      Console.WriteLine("Unknown Element")
      Console.WriteLine(ControlChars.Tab & e.Element.Name + " " & e.Element.InnerXml)
      Console.WriteLine(ControlChars.Tab & e.LineNumber & ":"  & e.LineNumber)
      Console.WriteLine(ControlChars.Tab & e.LinePosition & ":"   & e.LinePosition)
      
      Dim x As Group = CType( e.ObjectBeingDeserialized, Group)
      Console.WriteLine (x.GroupName)
      Console.WriteLine (sender.ToString())
   End Sub
   
   Private Sub DeserializeObject(filename As String)
      Dim ser As XmlSerializer = new XmlSerializer(GetType(Group))
      ' Add a delegate to handle unknown element events.
      AddHandler ser.UnknownElement, _
      AddressOf Serializer_UnknownElement 
      ' A FileStream is needed to read the XML document.
     Dim fs As FileStream  = new FileStream(filename, FileMode.Open)
     Dim g  As Group = CType(ser.Deserialize(fs),Group)
     fs.Close()
   End Sub
End Class

Hinweise

Standardmäßig werden nach dem Aufrufen der Deserialize Methode xml-Attribute XmlSerializer unbekannter Typen ignoriert. Sie können dieses Ereignis jedoch verwenden, um solche Knotentypen zu behandeln.

Note

Wenn dies XmlAnyElementAttribute auf ein Feld angewendet wird, das ein Array von XmlElement Objekten zurückgibt, werden alle unbekannten Elemente im Array erfasst. In diesem Fall tritt das UnknownElement Ereignis nicht auf.

Gilt für:

Weitere Informationen