Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

DataContractSerializer classe

 

Date de publication : novembre 2016

Sérialise et désérialise une instance d'un type dans un flux ou un document XML à l'aide d'un contrat de données fourni. Cette classe ne peut pas être héritée.

Espace de noms:   System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (dans System.Runtime.Serialization.dll)

System.Object
  System.Runtime.Serialization.XmlObjectSerializer
    System.Runtime.Serialization.DataContractSerializer

public sealed class DataContractSerializer : XmlObjectSerializer

NomDescription
System_CAPS_pubmethodDataContractSerializer(Type)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié.

System_CAPS_pubmethodDataContractSerializer(Type, DataContractSerializerSettings)

Initialise une nouvelle instance de la DataContractSerializer classe pour sérialiser ou désérialiser un objet du type spécifié et de paramètres.

System_CAPS_pubmethodDataContractSerializer(Type, IEnumerable<Type>)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié, et une collection de types connus pouvant être présents dans le graphique d'objets.

System_CAPS_pubmethodDataContractSerializer(Type, IEnumerable<Type>, Int32, Boolean, Boolean, IDataContractSurrogate)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également une liste des types connus qui peuvent être présents dans le graphique d'objets, le nombre maximal d'éléments de graphique à sérialiser, les paramètres pour ignorer les données inattendues, s'il faut utiliser des constructions XML non standard pour conserver les données de référence d'objet dans le graphique, et un substitut pour la sérialisation personnalisée.

System_CAPS_pubmethodDataContractSerializer(Type, IEnumerable<Type>, Int32, Boolean, Boolean, IDataContractSurrogate, DataContractResolver)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également une liste des types connus qui peuvent être présents dans le graphique d’objets, le nombre maximal d’éléments de graphique à sérialiser, les paramètres pour ignorer les données inattendues, s’il faut utiliser XML non standard construit pour conserver les données de référence d’objet dans le graphique, un substitut pour la sérialisation personnalisée et une autre pour le mappage xsi:type déclarations au moment de l’exécution.

System_CAPS_pubmethodDataContractSerializer(Type, String, String)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié à l'aide de l'élément racine et de l'espace de noms XML fournis.

System_CAPS_pubmethodDataContractSerializer(Type, String, String, IEnumerable<Type>)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également l'élément XML racine et l'espace de noms dans deux paramètres de chaîne ainsi qu'une liste des types connus pouvant être présents dans le graphique d'objets.

System_CAPS_pubmethodDataContractSerializer(Type, String, String, IEnumerable<Type>, Int32, Boolean, Boolean, IDataContractSurrogate)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également une liste des types connus qui peuvent être présents dans le graphique d'objets, le nombre maximal d'éléments de graphique à sérialiser, les paramètres pour ignorer des données inattendues, s'il faut utiliser des constructions XML non standard pour conserver les données de référence d'objet dans le graphique, un substitut pour la sérialisation personnalisée, ainsi que l'élément et l'espace de noms XML qui incluent le contenu.

System_CAPS_pubmethodDataContractSerializer(Type, String, String, IEnumerable<Type>, Int32, Boolean, Boolean, IDataContractSurrogate, DataContractResolver)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également une liste des types connus qui peuvent être présents dans le graphique d’objets, le nombre maximal d’éléments de graphique à sérialiser, les paramètres pour ignorer les données inattendues, s’il faut utiliser XML non standard construit pour conserver les données de référence d’objet dans le graphique, un substitut pour la sérialisation personnalisée, l’élément XML et l’espace de noms qui contient le contenu et une autre pour le mappage xsi:type déclarations au moment de l’exécution.

System_CAPS_pubmethodDataContractSerializer(Type, XmlDictionaryString, XmlDictionaryString)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié à l'aide de l'élément racine et de l'espace de noms XML spécifiés dans les paramètres de type XmlDictionaryString.

System_CAPS_pubmethodDataContractSerializer(Type, XmlDictionaryString, XmlDictionaryString, IEnumerable<Type>)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également l'élément XML racine et l'espace de noms dans deux paramètres XmlDictionaryString ainsi qu'une liste de types connus pouvant être présents dans le graphique d'objets.

System_CAPS_pubmethodDataContractSerializer(Type, XmlDictionaryString, XmlDictionaryString, IEnumerable<Type>, Int32, Boolean, Boolean, IDataContractSurrogate)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également une liste des types connus qui peuvent être présents dans le graphique d'objets, le nombre maximal d'éléments de graphique à sérialiser, les paramètres pour ignorer les données inattendues, s'il faut utiliser des constructions XML non standard pour conserver les données de référence d'objet dans le graphique, un substitut pour la sérialisation personnalisée, et les paramètres XmlDictionaryString qui spécifient l'élément et l'espace de noms XML qui contiennent le contenu.

System_CAPS_pubmethodDataContractSerializer(Type, XmlDictionaryString, XmlDictionaryString, IEnumerable<Type>, Int32, Boolean, Boolean, IDataContractSurrogate, DataContractResolver)

Initialise une nouvelle instance de la classe DataContractSerializer pour sérialiser ou désérialiser un objet du type spécifié. Cette méthode spécifie également une liste des types connus qui peuvent être présents dans le graphique d’objets, le nombre maximal d’éléments de graphique à sérialiser, les paramètres pour ignorer les données inattendues, s’il faut utiliser XML non standard construit pour conserver les données de référence d’objet dans le graphique, un substitut pour la sérialisation personnalisée, les paramètres de XmlDictionaryString qui spécifient l’élément XML et l’espace de noms qui contient le contenu et un autre pour le mappage xsi:type déclarations au moment de l’exécution.

NomDescription
System_CAPS_pubpropertyDataContractResolver

Obtient le composant utilisé pour mapper dynamiquement xsi:type déclarations de types de contrat connus.

System_CAPS_pubpropertyDataContractSurrogate

Obtient un type de substitut capable d’étendre le processus de sérialisation ou de désérialisation.

System_CAPS_pubpropertyIgnoreExtensionDataObject

Obtient une valeur qui spécifie s’il faut ignorer les données fournies par une extension de la classe lors de la sérialisation ou la désérialisation de la classe.

System_CAPS_pubpropertyKnownTypes

Obtient une collection des types pouvant être présents dans le graphique d'objets sérialisé à l'aide de cette instance de DataContractSerializer.

System_CAPS_pubpropertyMaxItemsInObjectGraph

Obtient le nombre maximal d'éléments à sérialiser ou désérialiser dans un graphique d'objets.

System_CAPS_pubpropertyPreserveObjectReferences

Obtient une valeur qui spécifie s'il faut utiliser des constructions XML non standard pour conserver des données de référence d'objet.

System_CAPS_pubpropertySerializeReadOnlyTypes

Obtient une valeur qui indique si les types en lecture seule sont sérialisées.

NomDescription
System_CAPS_pubmethodEquals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.(Hérité de Object.)

System_CAPS_pubmethodGetHashCode()

Fait office de fonction de hachage par défaut.(Hérité de Object.)

System_CAPS_pubmethodGetType()

Obtient le Type de l'instance actuelle.(Hérité de Object.)

System_CAPS_pubmethodIsStartObject(XmlDictionaryReader)

Détermine si la classe XmlDictionaryReader est positionnée sur un objet pouvant être désérialisé.(Remplace XmlObjectSerializer.IsStartObject(XmlDictionaryReader).)

System_CAPS_pubmethodIsStartObject(XmlReader)

Détermine si la classe XmlReader est positionnée sur un objet pouvant être désérialisé.(Remplace XmlObjectSerializer.IsStartObject(XmlReader).)

System_CAPS_pubmethodReadObject(Stream)

Lit le flux ou le document XML avec un Stream et retourne l'objet désérialisé.(Hérité de XmlObjectSerializer.)

System_CAPS_pubmethodReadObject(XmlDictionaryReader)

Lit le document ou le flux XML avec un XmlDictionaryReader et retourne l'objet désérialisé.(Hérité de XmlObjectSerializer.)

System_CAPS_pubmethodReadObject(XmlDictionaryReader, Boolean)

Lit le flux XML avec une classe XmlDictionaryReader et retourne l'objet désérialisé. Il spécifie également si un contrôle doit être effectué pour vérifier le nom de l'objet avant de lire sa valeur.(Remplace XmlObjectSerializer.ReadObject(XmlDictionaryReader, Boolean).)

System_CAPS_pubmethodReadObject(XmlDictionaryReader, Boolean, DataContractResolver)

Lit un document XML ou un flux de document et retourne l'objet désérialisé. La méthode inclut un paramètre pour spécifier si le nom de l’objet est vérifié est validé et un programme de résolution pour le mappage xsi:type déclarations lors de l’exécution.

System_CAPS_pubmethodReadObject(XmlReader)

Lit le flux XML avec une classe XmlReader et retourne l'objet désérialisé.(Remplace XmlObjectSerializer.ReadObject(XmlReader).)

System_CAPS_pubmethodReadObject(XmlReader, Boolean)

Lit le flux XML avec une classe XmlReader et retourne l'objet désérialisé. Il spécifie également si un contrôle doit être effectué pour vérifier le nom de l'objet avant de lire sa valeur.(Remplace XmlObjectSerializer.ReadObject(XmlReader, Boolean).)

System_CAPS_pubmethodToString()

Retourne une chaîne qui représente l'objet actuel.(Hérité de Object.)

System_CAPS_pubmethodWriteEndObject(XmlDictionaryWriter)

Écrit l'élément XML de fermeture à l'aide d'une classe XmlDictionaryWriter.(Remplace XmlObjectSerializer.WriteEndObject(XmlDictionaryWriter).)

System_CAPS_pubmethodWriteEndObject(XmlWriter)

Écrit l'élément XML de fermeture à l'aide d'une classe XmlWriter.(Remplace XmlObjectSerializer.WriteEndObject(XmlWriter).)

System_CAPS_pubmethodWriteObject(Stream, Object)

Écrit le contenu complet (début, contenu et fin) de l'objet dans le flux ou le document XML avec le Stream spécifié.(Hérité de XmlObjectSerializer.)

System_CAPS_pubmethodWriteObject(XmlDictionaryWriter, Object)

Écrit le contenu complet (début, contenu et fin) de l'objet dans le flux ou le document XML avec le XmlDictionaryWriter spécifié.(Hérité de XmlObjectSerializer.)

System_CAPS_pubmethodWriteObject(XmlDictionaryWriter, Object, DataContractResolver)

Écrit toutes les données d'objet (élément XML de début, contenu et élément englobant) dans un document ou un flux XML à l'aide du XmlDictionaryWriter spécifié. La méthode inclut un programme de résolution pour le mappage xsi:type déclarations lors de l’exécution.

System_CAPS_pubmethodWriteObject(XmlWriter, Object)

Écrit toutes les données d'objet (élément XML de début, de contenu et de fermeture) dans un document ou un flux XML avec une classe XmlWriter.(Remplace XmlObjectSerializer.WriteObject(XmlWriter, Object).)

System_CAPS_pubmethodWriteObjectContent(XmlDictionaryWriter, Object)
System_CAPS_pubmethodWriteObjectContent(XmlWriter, Object)

Écrit le contenu XML à l'aide d'une classe XmlWriter.(Remplace XmlObjectSerializer.WriteObjectContent(XmlWriter, Object).)

System_CAPS_pubmethodWriteStartObject(XmlDictionaryWriter, Object)

Écrit l'élément XML d'ouverture à l'aide d'une classe XmlDictionaryWriter.(Remplace XmlObjectSerializer.WriteStartObject(XmlDictionaryWriter, Object).)

System_CAPS_pubmethodWriteStartObject(XmlWriter, Object)

Écrit l'élément XML d'ouverture à l'aide d'une classe XmlWriter.(Remplace XmlObjectSerializer.WriteStartObject(XmlWriter, Object).)

Use the T:System.Runtime.Serialization.DataContractSerializer class to serialize and deserialize instances of a type into an XML stream or document. For example, you can create a type named Person with properties that contain essential data, such as a name and address. You can then create and manipulate an instance of the Person class and write all of its property values in an XML document for later retrieval, or in an XML stream for immediate transport. Most important, the T:System.Runtime.Serialization.DataContractSerializer is used to serialize and deserialize data sent in indigo1 messages. Apply the T:System.Runtime.Serialization.DataContractAttribute attribute to classes, and the T:System.Runtime.Serialization.DataMemberAttribute attribute to class members to specify properties and fields that are serialized.

Pour obtenir une liste de types that can be serialized, see Types pris en charge par le sérialiseur de contrat de données.

To use the T:System.Runtime.Serialization.DataContractSerializer, first create an instance of a class and an object appropriate to writing or reading the format; for example, an instance of the T:System.Xml.XmlDictionaryWriter. Then call the M:System.Runtime.Serialization.XmlObjectSerializer.WriteObject(System.Xml.XmlDictionaryWriter,System.Object) method to persist the data. To retrieve data, create an object appropriate to reading the data format (such as an T:System.Xml.XmlDictionaryReader for an XML document) and call the Overload:System.Runtime.Serialization.DataContractSerializer.ReadObject method.

Pour plus d'informations sur using the DataContractSerializer, see Sérialisation et désérialisation.

You can set the type of a data contract serializer using the <dataContractSerializer> element in a client application configuration file.

The T:System.Runtime.Serialization.DataContractSerializer is used in combination with the T:System.Runtime.Serialization.DataContractAttribute and T:System.Runtime.Serialization.DataMemberAttribute classes. To prepare a class for serialization, apply the T:System.Runtime.Serialization.DataContractAttribute to the class. For each member of the class that returns data that you want to serialize, apply the T:System.Runtime.Serialization.DataMemberAttribute. You can serialize fields and properties, regardless of accessibility: private, protected, internal, protected internal, or public.

For example, your schema specifies a Customer with an ID property, but you already have an existing application that uses a type named Person with a Name property. To create a type that conforms to the contract, first apply the T:System.Runtime.Serialization.DataContractAttribute to the class. Then apply the T:System.Runtime.Serialization.DataMemberAttribute to every field or property that you want to serialize.

System_CAPS_noteRemarque

You can apply the T:System.Runtime.Serialization.DataMemberAttribute to both private and public members.

The final format of the XML need not be text. Instead, the T:System.Runtime.Serialization.DataContractSerializer writes the data as an XML infoset, which allows you to write the data to any format recognized by the T:System.Xml.XmlReader and T:System.Xml.XmlWriter. It is recommended that you use the T:System.Xml.XmlDictionaryReader and T:System.Xml.XmlDictionaryWriter classes to read and write, because both are optimized to work with the T:System.Runtime.Serialization.DataContractSerializer.

If you are creating a class that has fields or properties that must be populated before the serialization or deserialization occurs, use callback attributes, as described in Version Tolerant Serialization Callbacks.

When serializing or deserializing an object, it is required that the type is "known" to the T:System.Runtime.Serialization.DataContractSerializer. Begin by creating an instance of a class that implements T:System.Collections.Generic.IEnumerable`1 (such as T:System.Collections.Generic.List`1) and adding the known types to the collection. Then create an instance of the T:System.Runtime.Serialization.DataContractSerializer using one of the overloads that takes the T:System.Collections.Generic.IEnumerable`1 (for example, M:System.Runtime.Serialization.DataContractSerializer.#ctor(System.Type,System.Collections.Generic.IEnumerable{System.Type}).

System_CAPS_noteRemarque

Unlike other primitive types, the T:System.DateTimeOffset structure is not a known type by default, so it must be manually added to the list of known types (see Data Contract Known Types).

The T:System.Runtime.Serialization.DataContractSerializer understands data contracts that have been designed to be compatible with future versions of the contract. Such types implement the T:System.Runtime.Serialization.IExtensibleDataObject interface. The interface features the P:System.Runtime.Serialization.IExtensibleDataObject.ExtensionData property that returns an T:System.Runtime.Serialization.ExtensionDataObject object. crdefaultForward Compatible Data Contracts.

When instantiating the target object during deserialization, the T:System.Runtime.Serialization.DataContractSerializer does not call the constructor of the target object. If you author a [DataContract] type that is accessible from partial trust (that is, it is public and in an assembly that has the AllowPartiallyTrustedCallers attribute applied) and that performs some security-related actions, you must be aware that the constructor is not called. In particular, the following techniques do not work:

  • If you try to restrict partial trust access by making the constructor internal or private, or by adding a LinkDemand to the constructor -- neither of these have any effect during deserialization under partial trust.

  • If you code the class that assumes the constructor has run, the class may get into an invalid internal state that is exploitable.

The following example code shows a type named Person that is serialized by the T:System.Runtime.Serialization.DataContractSerializer. The T:System.Runtime.Serialization.DataContractAttribute attribute is applied to the class, and the T:System.Runtime.Serialization.DataMemberAttribute is applied to members to instruct the T:System.Runtime.Serialization.DataContractSerializer what to serialize.

namespace DataContractSerializerExample
{
    using System;
    using System.Collections;
    using System.Collections.Generic;
    using System.Runtime.Serialization;
    using System.Xml;

    // You must apply a DataContractAttribute or SerializableAttribute
    // to a class to have it serialized by the DataContractSerializer.
    [DataContract(Name = "Customer", Namespace = "http://www.contoso.com")]
    class Person : IExtensibleDataObject
    {
        [DataMember()]
        public string FirstName;
        [DataMember]
        public string LastName;
        [DataMember()]
        public int ID;

        public Person(string newfName, string newLName, int newID)
        {
            FirstName = newfName;
            LastName = newLName;
            ID = newID;
        }

        private ExtensionDataObject extensionData_Value;

        public ExtensionDataObject ExtensionData
        {
            get
            {
                return extensionData_Value;
            }
            set
            {
                extensionData_Value = value;
            }
        }
    }

    public sealed class Test
    {
        private Test() { }

        public static void Main()
        {
            try
            {
                WriteObject("DataContractSerializerExample.xml");
                ReadObject("DataContractSerializerExample.xml");

            }

            catch (SerializationException serExc)
            {
                Console.WriteLine("Serialization Failed");
                Console.WriteLine(serExc.Message);
            }
            catch (Exception exc)
            {
                Console.WriteLine(
                "The serialization operation failed: {0} StackTrace: {1}",
                exc.Message, exc.StackTrace);
            }

            finally
            {
                Console.WriteLine("Press <Enter> to exit....");
                Console.ReadLine();
            }
        }

        public static void WriteObject(string fileName)
        {
            Console.WriteLine(
                "Creating a Person object and serializing it.");
            Person p1 = new Person("Zighetti", "Barbara", 101);
            FileStream writer = new FileStream(fileName, FileMode.Create);
            DataContractSerializer ser =
                new DataContractSerializer(typeof(Person));
            ser.WriteObject(writer, p1);
            writer.Close();
        }

        public static void ReadObject(string fileName)
        {
            Console.WriteLine("Deserializing an instance of the object.");
            FileStream fs = new FileStream(fileName,
            FileMode.Open);
            XmlDictionaryReader reader =
                XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
            DataContractSerializer ser = new DataContractSerializer(typeof(Person));

            // Deserialize the data and read it from the instance.
            Person deserializedPerson =
                (Person)ser.ReadObject(reader, true);
            reader.Close();
            fs.Close();
            Console.WriteLine(String.Format("{0} {1}, ID: {2}",
            deserializedPerson.FirstName, deserializedPerson.LastName,
            deserializedPerson.ID));
        }
    }

Plateforme Windows universelle
Disponible depuis 8
.NET Framework
Disponible depuis 3.0
Bibliothèque de classes portable
Pris en charge dans : plateformes .NET portables
Silverlight
Disponible depuis 2.0
Silverlight pour Windows Phone
Disponible depuis 7.0
Windows Phone
Disponible depuis 8.1

Instances of this class are thread safe except when the instance is used with an implementation of the T:System.Runtime.Serialization.IDataContractSurrogate or T:System.Runtime.Serialization.DataContractResolver.

Retour au début
Afficher: