SoapAttributes.SoapDefaultValue プロパティ

XML 要素または XML 属性の既定値を取得または設定します。

Public Property SoapDefaultValue As Object
[C#]
public object SoapDefaultValue {get; set;}
[C++]
public: __property Object* get_SoapDefaultValue();public: __property void set_SoapDefaultValue(Object*);
[JScript]
public function get SoapDefaultValue() : Object;public function set SoapDefaultValue(Object);

プロパティ値

XML 要素または XML 属性の既定値を表すオブジェクト。

解説

メンバの既定値は、そのメンバに DefaultValueAttribute 属性を適用することによって設定できます。メンバがエンコード済みの SOAP メッセージとしてシリアル化される場合に、その既定値を変更するには、新しい DefaultValueAttribute を作成し、その Value プロパティを設定し、このオブジェクトを SoapDefaultValue プロパティに設定します。次に、この SoapAttributes を SoapAttributeOverrides に追加します。詳細については、 SoapAttributeOverrides クラスの概要を参照してください。

使用例

[Visual Basic, C#, C++] GroupName という名前のフィールドが含まれている Group という名前のクラスをシリアル化する例を次に示します。既定値は、 DefaultValueAttribute を使用して ".NET" に設定されています。フィールドを設定しないか、またはフィールドを ".NET" に設定することにより、その値はシリアル化されなくなります (既定値が判明するため)。さらに、この例では、 CreateOverrideSerializer メソッドで既定値がオーバーライドされています。このメソッドは、 SerializeOverride メソッドによって呼び出されます。この例は、 SerializeOriginal メソッドおよび SerializeOverride メソッドの両方を呼び出し、 GroupName フィールドに対して同じ値 (".NET") を設定しています。指定されているオーバーライドにより、この値は SerializeOverride メソッドが呼び出された場合にだけシリアル化されます。

 
Imports System
Imports System.IO
Imports System.Xml
Imports System.Xml.Serialization
Imports System.Xml.Schema
Imports System.ComponentModel

Public Class Group
   ' The default is set to .NET.
   <DefaultValue(".NET")> _
   Public GroupName As String
End Class
 
Public Class Run

   Public Shared Sub Main()
   
      Dim test As Run = new Run()
      test.SerializeOriginal("SoapOriginal.xml")
      test.SerializeOverride _
      ("mySoapAttributeOverridesideAttributes.xml")
      test.DeserializeOriginal("SoapOriginal.xml")
      test.DeserializeOverride _
      ("mySoapAttributeOverridesideAttributes.xml")
   End Sub
   
   public Sub SerializeOriginal(filename As String)
       ' Create an instance of the XmlSerializer class.
      Dim mySerializer As XmlSerializer =  _
      new XmlSerializer(GetType(Group))

      ' Writing the file requires a TextWriter.
      Dim writer As TextWriter = new StreamWriter(filename)

      ' Create an instance of the class that will be serialized.
      Dim myGroup As Group = 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()
   End Sub

   Public Sub SerializeOverride(filename As String)
   
      ' Create an instance of the XmlSerializer class
      ' that overrides the serialization.
      Dim overRideSerializer As XmlSerializer = CreateOverrideSerializer()

      ' Writing the file requires a TextWriter.
      Dim writer As TextWriter = new StreamWriter(filename)

      ' Create an instance of the class that will be serialized.
      Dim myGroup As Group = 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()

   End Sub


   Public Sub DeserializeOriginal(filename As String)
   
      ' Create an instance of the XmlSerializer class.
      Dim mySerializer As XmlSerializer = new XmlSerializer(GetType(Group))
      ' Reading the file requires a TextReader.
      Dim reader As TextReader = new StreamReader(filename)

      ' Deserialize and cast the object.
      Dim myGroup As Group = CType(mySerializer.Deserialize(reader), Group)

      Console.WriteLine(myGroup.GroupName)
      Console.WriteLine()
   End Sub

   Public Sub DeserializeOverride(filename As String)
   
      ' Create an instance of the XmlSerializer class.
      Dim overRideSerializer As XmlSerializer = CreateOverrideSerializer()
      ' Reading the file requires a TextReader.
      Dim reader As TextReader = new StreamReader(filename)

      ' Deserialize and cast the object.
      Dim myGroup As Group = CType(overRideSerializer.Deserialize(reader), Group)

      Console.WriteLine(myGroup.GroupName)

   End Sub

   Private Function CreateOverrideSerializer() As XmlSerializer 
   
      Dim mySoapAttributeOverrides As SoapAttributeOverrides  = _
      New SoapAttributeOverrides()
      Dim soapAtts As SoapAttributes = New SoapAttributes()
      ' Create a new DefaultValueAttribute object for the GroupName
      ' property.
      Dim newDefault As DefaultValueAttribute = _
      new DefaultValueAttribute("Team1")
      soapAtts.SoapDefaultValue = newDefault

     mySoapAttributeOverrides.Add(GetType(Group), "GroupName", _
     soapAtts)
      
      ' Create an XmlTypeMapping that is used to create an instance 
      ' of the XmlSerializer. Then return the XmlSerializer object.
      Dim myMapping As XmlTypeMapping = _
      (New SoapReflectionImporter( _
      mySoapAttributeOverrides)).ImportTypeMapping(GetType(Group))
    
      Dim ser As XmlSerializer = new XmlSerializer(myMapping)
      return ser
   End Function
End Class

[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;
   }

}

[C++] 
#using <mscorlib.dll>
#using <System.dll>
#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
using namespace System::Xml::Serialization;
using namespace System::Xml::Schema;
using namespace System::ComponentModel;

public __gc class Group {
public:
    // The default is set to .NET.
    [DefaultValue(S".NET")]
    String* GroupName;
};

public __gc class Run {
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 = S".NET";

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

    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  specifies that the default value is now 
        // 'Team1'. So setting the GroupName to '.NET' means
        // the value will be serialized.
        myGroup->GroupName = S".NET";
        // Serialize the class, and close the TextWriter.
        overRideSerializer->Serialize(writer, myGroup);
        writer->Close();
    }

    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 = __try_cast<Group*>( mySerializer->Deserialize(reader) );

        Console::WriteLine(myGroup->GroupName);
        Console::WriteLine();
    }

    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 = __try_cast<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(S"Team1");
        soapAtts->SoapDefaultValue = newDefault;

        mySoapAttributeOverrides->Add(__typeof(Group), S"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;
    }
};

int main() {
    Run* test = new Run();
    test->SerializeOriginal(S"SoapOriginal.xml");
    test->SerializeOverride(S"mySoapAttributeOverridesideAttributes.xml");
    test->DeserializeOriginal(S"SoapOriginal.xml");
    test->DeserializeOverride(S"mySoapAttributeOverridesideAttributes.xml");
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

参照

SoapAttributes クラス | SoapAttributes メンバ | System.Xml.Serialization 名前空間 | XmlAttributes | エンコード済み SOAP シリアル化を制御する属性 | XML シリアル化を使用した SOAP メッセージの生成