XmlSerializer.UnknownAttribute イベント

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

Public Event UnknownAttribute As XmlAttributeEventHandler
[C#]
public event XmlAttributeEventHandler UnknownAttribute;
[C++]
public: __event XmlAttributeEventHandler* UnknownAttribute;

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

イベント データ

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

解説

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

逆シリアル化されるクラスのインスタンスに、 XmlAttribute オブジェクトの配列を返すフィールドが含まれていて、そのフィールドに XmlAnyAttributeAttribute が適用されている場合は、 UnknownAttribute イベントは発生しません。代わりに、不明な XML 属性がすべて、その配列内にまとめて挿入されます。

使用例

[Visual Basic, C#, C++] 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("UnknownAttributes.xml")
   End Sub

   Private Sub Serializer_UnknownAttribute _
   (sender As Object , e As XmlAttributeEventArgs)
      Console.WriteLine("Unknown Attribute")
      Console.WriteLine(ControlChars.Tab & e.Attr.Name + " " & e.Attr.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.UnknownAttribute, _
      AddressOf Serializer_UnknownAttribute 
      ' 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("UnknownAttributes.xml");
   }
   private void Serializer_UnknownAttribute(object sender, XmlAttributeEventArgs e){
      Console.WriteLine("Unknown Attribute");
      Console.WriteLine("\t" + e.Attr.Name + " " + e.Attr.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.UnknownAttribute+=new XmlAttributeEventHandler(Serializer_UnknownAttribute);
      // 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 <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml::Serialization;
using namespace System::Xml;
using namespace System::Xml::Schema;

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

public __gc class Test{
public:
   static void main(){
      Test* t = new Test();
      // Deserialize the file containing unknown elements.
      t->DeserializeObject(S"UnknownAttributes.xml");
   }
private:
   void Serializer_UnknownAttribute(Object* sender, XmlAttributeEventArgs* e){
      Console::WriteLine(S"Unknown Attribute");
      Console::WriteLine(S"\t{0} {1}", e->Attr->Name, e->Attr->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);
   }
private:
   void DeserializeObject(String* filename){
      XmlSerializer* ser = new XmlSerializer(__typeof(Group));
      // Add a delegate to handle unknown element events.
      ser->UnknownAttribute+=new XmlAttributeEventHandler(this, &Test::Serializer_UnknownAttribute);
      // 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::main();
}

[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 クラス | XmlSerializer メンバ | System.Xml.Serialization 名前空間 | XmlAnyAttributeAttribute | CanDeserialize | Deserialize | UnknownNode | XML シリアル化の概要 | 属性を使用した XML シリアル化の制御 | XML シリアル化の例 | XML スキーマ定義ツールと XML シリアル化