XmlSerializer.UnknownElement イベント

[アーティクル]
03/28/2008

逆シリアル化時に XmlSerializer が不明な型の XML 要素を認識した場合に発生します。

Public Event UnknownElement As XmlElementEventHandler
[C#]
public event XmlElementEventHandler UnknownElement;
[C++]
public: __event XmlElementEventHandler* UnknownElement;

[JScript] JScript では、このクラスで定義されているイベントを処理できます。ただし、独自に定義することはできません。

イベントデータ

イベントハンドラが、このイベントに関連するデータを含む、XmlElementEventArgs 型の引数を受け取りました。次の XmlElementEventArgs プロパティには、このイベントの固有の情報が記載されます。

プロパティ	説明
Element	不明な XML 要素を表すオブジェクトを取得します。
LineNumber	XML リーダーが XmlTextReader の場合に、不明な要素が見つかった場所の行番号を取得します。
LinePosition	XML リーダーが XmlTextReader の場合に、不明な要素が見つかった行内の位置を取得します。
ObjectBeingDeserialized	XmlSerializer が逆シリアル化しているオブジェクトを取得します。

解説

既定では、 Deserialize メソッドを呼び出した後は、 XmlSerializer は不明な型の XML 属性を無視します。ただし、このイベントを使用することにより、このようなノード型を処理できます。

メモ XmlElement オブジェクトの配列を返すフィールドに XmlAnyElementAttribute が適用されている場合は、すべての不明な要素は、その配列内にまとめて挿入されます。この場合、 UnknownElement イベントは発生しません。

使用例

[Visual Basic, C#, C++] UnknownElements.xml という名前のファイルから Group という名前のクラスを逆シリアル化する例を次に示します。ファイル内の要素に対応するメンバがクラス内にない場合は、常に UnknownElement イベントが発生します。このサンプルコードを実行するには、UnknownElements.xml という名前のファイルに次の XML コードを貼り付けます。

 
Imports System
Imports System.IO
Imports System.Xml.Serialization
Imports System.Xml
Imports System.Xml.Schema
Imports Microsoft.VisualBasic

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

[C#] 
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();
       }
}

[C++] 
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
using namespace System::Xml;
using namespace System::Xml::Schema;

__gc public class Group
{
public:
   String* GroupName;
};

__gc public class Test
{
public:
   void Serializer_UnknownElement(Object* sender, XmlElementEventArgs * e) 
   {
      Console::WriteLine(S"Unknown Element");
      Console::Write(S"\t {0}", e -> Element -> Name);
      Console::WriteLine(S" {0}", e -> Element -> InnerXml);
      Console::WriteLine(S"\t LineNumber: {0}", __box(e -> LineNumber));
      Console::WriteLine(S"\t LinePosition: {0}", __box(e -> LinePosition));

      Group *x  = dynamic_cast<Group*>(e -> ObjectBeingDeserialized);
      Console::WriteLine (x -> GroupName);
      Console::WriteLine (sender);
   }
   void DeserializeObject(String* filename)
   {
      XmlSerializer* ser = new XmlSerializer(__typeof(Group));
      // Add a delegate to handle unknown element events.
      ser -> UnknownElement += new XmlElementEventHandler(this, &Test::Serializer_UnknownElement);
      // A FileStream is needed to read the XML document.
      FileStream* fs = new FileStream(filename, FileMode::Open);
      Group *g = dynamic_cast<Group*>(ser -> Deserialize(fs));
      fs -> Close();
   }
};

int main()
{
   Test* t = new Test();
   // Deserialize the file containing unknown elements.
   t -> DeserializeObject(S"UnknownElements.xml");
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

参照

次の方法で共有

XmlSerializer.UnknownElement イベント

イベントデータ

解説

使用例

必要条件

参照

その他のリソース

次の方法で共有

XmlSerializer.UnknownElement イベント

イベント データ

解説

使用例

必要条件

参照

その他のリソース

イベントデータ