UnreferencedObjectEventArgs Class

Provides data for the known, but unreferenced, object found in an encoded SOAP XML stream during deserialization.

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

public class UnreferencedObjectEventArgs : EventArgs

For more information about the UnreferencedObjectEventArgs class, see the UnreferencedObject event of the XmlSerializer.

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

For more information about handling events, see Events Overview (Windows Forms)

The following example adds an UnreferencedObjectEventHandler to an XmlSerializer. The event is handled by the Serializer_UnreferencedObject method. To run the example, cut and paste the following XML into a file named UnrefObj.xml.

 <wrapper>
   <Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" id="id1" n1:GroupName=".NET" xmlns:n1="http://www.cpandl.com">
    </Group>
 <Vehicle id="id2" n1:type="Vehicle" xmlns:n1="http://www.w3.org/2001/XMLSchema-instance">
     <licenseNumber xmlns:q1="http://www.w3.org/2001/XMLSchema" n1:type="q1:string">ABCD</licenseNumber>
   </Vehicle>
 <Vehicle id="id3" n1:type="Vehicle" xmlns:n1="http://www.w3.org/2001/XMLSchema-instance">
     <licenseNumber xmlns:q1="http://www.w3.org/2001/XMLSchema" n1:type="q1:string">1234</licenseNumber>
   </Vehicle>
 </wrapper>
using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;

// You must use the SoapIncludeAttribute to inform the XmlSerializer 
// that the Vehicle type should be recognized when deserializing.
[SoapInclude(typeof(Vehicle))]
public class Group
{
   public string GroupName;
   public Vehicle GroupVehicle;
}
 [SoapInclude(typeof(Vehicle))]
public class Vehicle
{
   public string licenseNumber;
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.DeserializeObject("UnrefObj.xml");
   }

   public void DeserializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlTypeMapping myMapping = 
      (new SoapReflectionImporter().ImportTypeMapping(
      typeof(Group)));
      XmlSerializer mySerializer =  
      new XmlSerializer(myMapping);

      mySerializer.UnreferencedObject += 
      new UnreferencedObjectEventHandler
      (Serializer_UnreferencedObject);

      // Reading the file requires an  XmlTextReader.
      XmlTextReader reader= 
      new XmlTextReader(filename);
      reader.ReadStartElement();

      // Deserialize and cast the object.
      Group myGroup; 
      myGroup = (Group) mySerializer.Deserialize(reader);
      reader.ReadEndElement();
      reader.Close();
   }

   private void Serializer_UnreferencedObject
   (object sender, UnreferencedObjectEventArgs e){
      Console.WriteLine("UnreferencedObject:");
      Console.WriteLine("ID: " + e.UnreferencedId);
      Console.WriteLine("UnreferencedObject: " + e.UnreferencedObject);
      Vehicle myVehicle = (Vehicle) e.UnreferencedObject;
      Console.WriteLine("License: " + myVehicle.licenseNumber);
   }
}

// The file named "UnrefObj.xml" should contain this XML:

// <wrapper> 

//  <Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
//xmlns:xsd="http://www.w3.org/2001/XMLSchema" id="id1"  
//n1:GroupName=".NET" xmlns:n1="http://www.cpandl.com">
//   </Group> 

//<Vehicle id="id2" n1:type="Vehicle"  
//xmlns:n1="http://www.w3.org/2001/XMLSchema-instance">
//   <licenseNumber xmlns:q1="http://www.w3.org/2001/XMLSchema"  
//n1:type="q1:string">ABCD</licenseNumber>
//   </Vehicle> 

//<Vehicle id="id3" n1:type="Vehicle"  
//xmlns:n1="http://www.w3.org/2001/XMLSchema-instance">
//    <licenseNumber xmlns:q1="http://www.w3.org/2001/XMLSchema"  
//n1:type="q1:string">1234</licenseNumber>
//  </Vehicle> 

//</wrapper>
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Text;
using namespace System::Xml;
using namespace System::Xml::Serialization;
using namespace System::Xml::Schema;

__gc public class Vehicle;
[SoapInclude(__typeof(Vehicle))]
__gc public class Vehicle
{
public:
   String* licenseNumber;
};

// You must use the SoapIncludeAttribute to inform the XmlSerializer
// that the Vehicle type should be recognized when deserializing.
[SoapInclude(__typeof(Vehicle))]
__gc public class Group
{
public:
   String* GroupName;
   Vehicle * GroupVehicle;
};

__gc public class Run 
{
public:
   void DeserializeObject(String* filename) 
   {
      // Create an instance of the XmlSerializer class.
      XmlTypeMapping * myMapping = 
         ((new SoapReflectionImporter()) -> ImportTypeMapping(__typeof(Group)));
      XmlSerializer* mySerializer = new XmlSerializer(myMapping);

      mySerializer -> UnreferencedObject += new UnreferencedObjectEventHandler
         (this, &Run::Serializer_UnreferencedObject);

      // Reading the file requires an  XmlTextReader.
      XmlTextReader* reader = new XmlTextReader(filename);
      reader -> ReadStartElement();

      // Deserialize and cast the object.
      Group * myGroup; 
      myGroup = dynamic_cast<Group*>(mySerializer -> Deserialize(reader));
      reader -> ReadEndElement();
      reader -> Close();
   }

private:
   void Serializer_UnreferencedObject(Object* /*sender*/, UnreferencedObjectEventArgs * e) 
   {
      Console::WriteLine(S"UnreferencedObject:");
      Console::WriteLine(S"ID: {0}", e -> UnreferencedId);
      Console::WriteLine(S"UnreferencedObject: {0}", e -> UnreferencedObject);
      Vehicle * myVehicle = dynamic_cast<Vehicle*>(e -> UnreferencedObject);
      Console::WriteLine(S"License: {0}", myVehicle -> licenseNumber);
   }
};

int main() 
{
   Run* test = new Run();
   test -> DeserializeObject(S"UnrefObj.xml");
}


// The file named S"UnrefObj.xml" should contain this XML:

// <wrapper>

//  <Group xmlns:xsi=S"http://www.w3.org/2001/XMLSchema-instance" 
//xmlns:xsd=S"http://www.w3.org/2001/XMLSchema" id=S"id1" 
//n1:GroupName=S".NET" xmlns:n1=S"http://www.cpandl.com">
//   </Group>

//<Vehicle id=S"id2" n1:type=S"Vehicle" 
//xmlns:n1=S"http://www.w3.org/2001/XMLSchema-instance">
//   <licenseNumber xmlns:q1=S"http://www.w3.org/2001/XMLSchema" 
//n1:type=S"q1:String*">ABCD</licenseNumber>
//   </Vehicle>

//<Vehicle id=S"id3" n1:type=S"Vehicle" 
//xmlns:n1=S"http://www.w3.org/2001/XMLSchema-instance">
//    <licenseNumber xmlns:q1=S"http://www.w3.org/2001/XMLSchema" 
//n1:type=S"q1:String*">1234</licenseNumber>
//  </Vehicle>

//</wrapper>

System.Object
  System.EventArgs
    System.Xml.Serialization.UnreferencedObjectEventArgs

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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft