XmlElementEventArgs Class
Provides data for the UnknownElement event.
Assembly: System.Xml (in System.Xml.dll)
The XmlElementEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | Element | Gets the object that represents the unknown XML element. |
![]() | ExpectedElements | Gets a comma-delimited list of XML element names expected to be in an XML document instance. |
![]() ![]() | LineNumber | Gets the line number where the unknown element was encountered if the XML reader is an XmlTextReader. |
![]() ![]() | LinePosition | Gets the place in the line where the unknown element occurs if the XML reader is an XmlTextReader. |
![]() ![]() | ObjectBeingDeserialized | Gets the object the XmlSerializer is deserializing. |
| Name | Description | |
|---|---|---|
![]() ![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
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" ); }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
