Export (0) Print
Expand All

XmlElementEventArgs Class

Provides data for the UnknownElement event.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

public ref class XmlElementEventArgs : public EventArgs
public class XmlElementEventArgs extends EventArgs
public class XmlElementEventArgs extends EventArgs

For more information about handling events, see Events and Delegates and Raising an Event.

The UnknownElement event occurs only when you call the Deserialize method.

The following example deserializes a class named Group from a file named UnknownElements.xml. Whenever an element is found in the file that has no corresponding member in the class, the UnknownElement event occurs. To try the example, paste the following XML code into a file named UnknownElements.xml.

 <?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.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 ref class Group
{
public:
   String^ GroupName;
};

public ref class Test
{
private:
   void Serializer_UnknownElement( Object^ sender, XmlElementEventArgs^ e )
   {
      Console::WriteLine( "Unknown Element" );
      Console::Write( "\t {0}", e->Element->Name );
      Console::WriteLine( " {0}", e->Element->InnerXml );
      Console::WriteLine( "\t LineNumber: {0}", e->LineNumber );
      Console::WriteLine( "\t LinePosition: {0}", e->LinePosition );
      Group^ x = dynamic_cast<Group^>(e->ObjectBeingDeserialized);
      Console::WriteLine( x->GroupName );
      Console::WriteLine( sender );
   }

public:
   void DeserializeObject( String^ filename )
   {
      XmlSerializer^ ser = gcnew XmlSerializer( Group::typeid );

      // Add a delegate to handle unknown element events.
      ser->UnknownElement += gcnew XmlElementEventHandler( this, &Test::Serializer_UnknownElement );

      // A FileStream is needed to read the XML document.
      FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
      Group^ g = dynamic_cast<Group^>(ser->Deserialize( fs ));
      fs->Close();
   }
};

int main()
{
   Test^ t = gcnew Test;

   // Deserialize the file containing unknown elements.
   t->DeserializeObject( "UnknownElements.xml" );
}

import System.*;
import System.IO.*;
import System.Xml.Serialization.*;
import System.Xml.*;
import System.Xml.Schema.*;
public class Group
{
    public String GroupName;
} //Group

public class Test
{
    public static void main(String[] args)
    {
        Test t = new Test();
        // Deserialize the file containing unknown elements.
        t.DeserializeObject("UnknownElements.xml");
    } //main

    private void Serializer_UnknownElement(Object sender, 
        XmlElementEventArgs e)
    {
        Console.WriteLine("Unknown Element");
        Console.WriteLine("\t" + e.get_Element().get_Name() + " " 
            + e.get_Element().get_InnerXml());
        Console.WriteLine("\t LineNumber: " + e.get_LineNumber());
        Console.WriteLine("\t LinePosition: " + e.get_LinePosition());

        Group x = (Group)(e.get_ObjectBeingDeserialized());
        Console.WriteLine(x.GroupName);
        Console.WriteLine(sender.ToString());
    } //Serializer_UnknownElement

    private void DeserializeObject(String fileName)
    {
        XmlSerializer ser = new XmlSerializer(Group.class.ToType());
        // Add a delegate to handle unknown element events.
        ser.add_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();
    } //DeserializeObject
} //Test

System.Object
   System.EventArgs
    System.Xml.Serialization.XmlElementEventArgs

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft