SoapAttributes.SoapDefaultValue Propriété

Définition

Espace de noms:

System.Xml.Serialization

Assembly:

System.Xml.XmlSerializer.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Obtient ou définit la valeur par défaut d'un élément XML ou d'un attribut XML.

C#

public object? SoapDefaultValue { get; set; }

C#

public object SoapDefaultValue { get; set; }

Valeur de propriété

Object

Objet qui représente la valeur par défaut d'un élément XML ou d'un attribut XML.

Exemples

L’exemple suivant sérialise une classe nommée Group qui inclut un champ nommé GroupName. La valeur par défaut est définie avec la DefaultValueAttribute valeur « . NET ». En ne définissant pas le champ ou en le définissant sur « NET », la valeur n’est pas sérialisée (car la valeur par défaut est déjà connue). L’exemple remplace également la valeur par défaut dans la CreateOverrideSerializer méthode, appelée par la SerializeOverride méthode. L’exemple appelle les deux méthodes SerializeOriginal et SerializeOverridedéfinit la même valeur (« .NET ») pour le GroupName champ. En raison du remplacement, la valeur est sérialisée uniquement lors de l’appel de la SerializeOverride méthode.

C#

using System;
using System.IO;
using System.Xml;
using System.Xml.Serialization;
using System.Xml.Schema;
using System.ComponentModel;

public class Group
{
   // The default is set to .NET.
   [DefaultValue(".NET")]
   public string GroupName;
}

public class Run
{
   public static void Main()
   {
      Run test = new Run();
      test.SerializeOriginal("SoapOriginal.xml");
      test.SerializeOverride("mySoapAttributeOverridesideAttributes.xml");
      test.DeserializeOriginal("SoapOriginal.xml");
      test.DeserializeOverride("mySoapAttributeOverridesideAttributes.xml");
   }
   public void SerializeOriginal(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer =
      new XmlSerializer(typeof(Group));

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // Setting the GroupName to '.NET' is like not setting it at all
      // because it is the default value. So no value will be
      // serialized, and on deserialization it will appear as a blank.
      myGroup.GroupName = ".NET";

      // Serialize the class, and close the TextWriter.
      mySerializer.Serialize(writer, myGroup);
      writer.Close();
   }

   public void SerializeOverride(string filename)
   {
      // Create an instance of the XmlSerializer class
      // that overrides the serialization.
      XmlSerializer overRideSerializer = CreateOverrideSerializer();

      // Writing the file requires a TextWriter.
      TextWriter writer = new StreamWriter(filename);

      // Create an instance of the class that will be serialized.
      Group myGroup = new Group();

      // The override specifies that the default value is now
      // 'Team1'. So setting the GroupName to '.NET' means
      // the value will be serialized.
      myGroup.GroupName = ".NET";
      // Serialize the class, and close the TextWriter.
      overRideSerializer.Serialize(writer, myGroup);
       writer.Close();
   }

   public void DeserializeOriginal(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer= new XmlSerializer(typeof(Group));
      // Reading the file requires a TextReader.
      TextReader reader = new StreamReader(filename);

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

      Console.WriteLine(myGroup.GroupName);
      Console.WriteLine();
   }

   public void DeserializeOverride(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer overRideSerializer = CreateOverrideSerializer();
      // Reading the file requires a TextReader.
      TextReader reader = new StreamReader(filename);

      // Deserialize and cast the object.
      Group myGroup;
      myGroup = (Group) overRideSerializer.Deserialize(reader);

      Console.WriteLine(myGroup.GroupName);
   }

   private XmlSerializer CreateOverrideSerializer()
   {
      SoapAttributeOverrides mySoapAttributeOverrides =
      new SoapAttributeOverrides();
      SoapAttributes soapAtts = new SoapAttributes();
      // Create a new DefaultValueAttribute object for the GroupName
      // property.
      DefaultValueAttribute newDefault =
      new DefaultValueAttribute("Team1");
      soapAtts.SoapDefaultValue = newDefault;

      mySoapAttributeOverrides.Add(typeof(Group), "GroupName",
      soapAtts);

      // Create an XmlTypeMapping that is used to create an instance
      // of the XmlSerializer. Then return the XmlSerializer object.
      XmlTypeMapping myMapping = (new SoapReflectionImporter(
      mySoapAttributeOverrides)).ImportTypeMapping(typeof(Group));
    
      XmlSerializer ser = new XmlSerializer(myMapping);
      return ser;
   }
}

Remarques

La valeur par défaut d’un membre peut être définie en appliquant un DefaultValueAttribute attribut au membre. Si le membre est sérialisé en tant que message SOAP encodé, vous pouvez modifier la valeur par défaut en créant une propriété DefaultValueAttribute, en définissant sa Value propriété et en définissant la SoapDefaultValue propriété sur l’objet. Ajoutez le SoapAttributes à un SoapAttributeOverrides. Pour plus d’informations, consultez la vue d’ensemble de la SoapAttributeOverrides classe.

S’applique à

Voir aussi

• XmlAttributes
• Attributs qui contrôlent la sérialisation encodée selon le protocole SOAP
• Comment : sérialiser un objet en tant que flux XML encodé selon le protocole SOAP