XmlSerializer.UnreferencedObject Événement
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Se produit lors de la désérialisation d'un flux XML encodé à l'aide de SOAP, lorsque XmlSerializer rencontre un type reconnu mais non utilisé ou non référencé.
public:
event System::Xml::Serialization::UnreferencedObjectEventHandler ^ UnreferencedObject;public event System.Xml.Serialization.UnreferencedObjectEventHandler UnreferencedObject;member this.UnreferencedObject : System.Xml.Serialization.UnreferencedObjectEventHandler Public Custom Event UnreferencedObject As UnreferencedObjectEventHandler L’exemple suivant ajoute un UnreferencedObjectEventHandler à un XmlSerializer. L’événement est géré par la Serializer``_``UnreferencedObject méthode . Pour exécuter l’exemple, coupez et collez le code XML suivant dans un fichier nommé « 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.Xml.dll>
#using <System.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;
ref class Vehicle;
[SoapInclude(Vehicle::typeid)]
public ref class Vehicle
{
public:
String^ licenseNumber;
};
// You must use the SoapIncludeAttribute to inform the XmlSerializer
// that the Vehicle type should be recognized when deserializing.
[SoapInclude(Vehicle::typeid)]
public ref class Group
{
public:
String^ GroupName;
Vehicle^ GroupVehicle;
};
public ref class Run
{
public:
void DeserializeObject( String^ filename )
{
// Create an instance of the XmlSerializer class.
XmlTypeMapping^ myMapping = ((gcnew SoapReflectionImporter)->ImportTypeMapping( Group::typeid ));
XmlSerializer^ mySerializer = gcnew XmlSerializer( myMapping );
mySerializer->UnreferencedObject += gcnew UnreferencedObjectEventHandler( this, &Run::Serializer_UnreferencedObject );
// Reading the file requires an XmlTextReader.
XmlTextReader^ reader = gcnew 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( "UnreferencedObject:" );
Console::WriteLine( "ID: {0}", e->UnreferencedId );
Console::WriteLine( "UnreferencedObject: {0}", e->UnreferencedObject );
Vehicle^ myVehicle = dynamic_cast<Vehicle^>(e->UnreferencedObject);
Console::WriteLine( "License: {0}", myVehicle->licenseNumber );
}
};
int main()
{
Run^ test = gcnew Run;
test->DeserializeObject( "UnrefObj.xml" );
}
// The file named S"UnrefObj.xml" should contain this XML:
// <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">
//<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 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>
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:
// <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">
//<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 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>
Imports System.IO
Imports System.Text
Imports System.Xml
Imports System.Xml.Serialization
Imports System.Xml.Schema
' You must use the SoapIncludeAttribute to inform the XmlSerializer
' that the Vehicle type should be recognized when deserializing.
<SoapInclude(GetType(Vehicle))> _
Public Class Group
Public GroupName As String
public GroupVehicle As Vehicle
End Class
Public Class Vehicle
Public licenseNumber As String
End Class
Public Class Run
Shared Sub Main()
Dim test As Run = new Run()
test.DeserializeObject("UnrefObj.xml")
End Sub
Public Sub DeserializeObject(filename As String)
' Create an instance of the XmlSerializer class.
Dim myMapping As XmlTypeMapping = _
(new SoapReflectionImporter().ImportTypeMapping _
(GetType(Group)))
Dim mySerializer As XmlSerializer = _
new XmlSerializer(myMapping)
AddHandler mySerializer.UnreferencedObject, _
AddressOf Serializer_UnreferencedObject
' Reading the file requires an XmlTextReader.
Dim reader As XmlTextReader = _
new XmlTextReader(filename)
reader.ReadStartElement()
' Deserialize and cast the object.
Dim myGroup As Group
myGroup = CType( mySerializer.Deserialize(reader), Group)
reader.ReadEndElement()
reader.Close()
End Sub
Private Sub Serializer_UnreferencedObject _
(sender As object , e As UnreferencedObjectEventArgs)
Console.WriteLine("UnreferencedObject:")
Console.WriteLine("ID: " + e.UnreferencedId)
Console.WriteLine("UnreferencedObject: " + e.UnreferencedObject)
Dim myVehicle As Vehicle = CType(e.UnreferencedObject, Vehicle)
Console.WriteLine("License: " + myVehicle.licenseNumber)
End Sub
End Class
' The XML document should contain this information:
' <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">
'<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 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>
L’événement UnreferencedObject se produit uniquement lorsque le XmlSerializer est utilisé pour désérialiser un document XML qui contient un message SOAP conforme à la section 5 du document du World Wide Web Consortium, SOAP (Simple Object Access Protocol) 1.1.
Les documents conformes à la section 5 sont dans un format spécial. À tout le moins, un tel document inclut le corps main du message SOAP. Toutefois, au lieu d’avoir tous les types définis en ligne dans le document, certaines définitions de type peuvent être encodées en tant que références à des éléments de niveau supérieur dans le document. Par conséquent, pour chaque élément trouvé dans le corps du main qui est une référence, il doit y avoir un élément correspondant qui contient la définition de type. Pour mettre en corrélation l’élément de référencement et la définition de type, la définition de type a un id attribut défini sur un ID de chaîne unique et l’élément de référencement a un href attribut qui fait référence au même ID.
<Group xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" id="id1" n1:GroupName=".NET" GroupNumber="ZDI=" CreationDate="2002-05-02" xmlns:n1="http:'www.cpandl.com">
<PosInt xsi:type="xsd:nonNegativeInteger">10000</PosInt>
<GroupVehicle href="#id2" />
</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">1234</licenseNumber>
</Vehicle>
L’événement UnreferencedObject se produit lorsqu’une définition de type est trouvée dans le document, mais qu’aucun paramètre dans le corps main ne le référence. Lorsque l’événement se produit, vous pouvez récupérer le type XML de l’objet non référencé en examinant la UnreferencedObject propriété de la UnreferencedObjectEventArgs classe . L’ID XML de l’objet est retourné par la UnreferencedId propriété .
L’événement UnreferencedObject ne doit pas être confondu avec les UnknownElement événements et UnknownNode , qui se produisent lorsqu’aucun membre de classe ne correspond au type d’élément ou de nœud XML.
| Produit | Versions |
|---|---|
| .NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0, 2.1 |
Commentaires sur .NET
.NET est un projet open source. Sélectionnez un lien pour fournir des commentaires :