XmlAttributes.XmlDefaultValue プロパティ

[アーティクル]
03/28/2008

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

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

プロパティ値

XML 要素または XML 属性の既定値を表す Object 。

解説

メンバに DefaultValueAttribute を適用することで XML 要素または XML 属性の既定値を指定できます。値を適用した結果を調べるには、アプリケーションを DLL または実行可能ファイルにコンパイルし、その結果生成されたファイルを引数として XML スキーマ定義ツール (XSD.exe) に渡します。XML スキーマドキュメントでは、既定値が default 属性に代入されます。次の例では、Animal 要素の既定値は "Dogs" です。

<?xml version="1.0"?>
<schema attributeFormDefault="qualified" 
elementFormDefault="qualified" targetNamespace="" 
xmlns="http://www.w3.org/2000/10/XMLSchema">
  <element name="Pets" nullable="true" type="Pets"/>
  <complexType name="Pets">
    <sequence>
      <element default="Dogs" name="Animal" nullable="true" 
       type="string" minOccurs="0"/>
    </sequence>
  </complexType>
</schema>

既定値をオーバーライドするには、 Object を作成して XmlDefaultValue に代入します。

フィールドまたはプロパティに代入された値が、そのフィールドまたはプロパティの既定値と等しい場合は、 XmlSerializer は値を XML インスタンスにシリアル化しません。これは、代入された値を XML スキーマから復元できるためです。つまり、フィールドまたはプロパティをその既定値に設定することは、設定しないのと同じです。同様に、フィールドまたはプロパティに値が設定されていない場合、 XmlSerializer はスキーマにある既定値を使用します。プロパティを既定値に設定した場合も設定しなかった場合も、XML ドキュメントインスタンスには、そのプロパティの値は格納されません。

使用例

[Visual Basic, C#, C++] 既定値が "Dog" に設定されているフィールドを保持している Pet という名前のクラスの例を次に示します。この例では、 XmlAttributes オブジェクトも作成し、その XmlDefaultValue プロパティを新しい既定値 ("Cat") に設定します。これにより元の既定値がオーバーライドされます。したがって、フィールド値を "Cat" に設定すると、 XmlSerializer は、そのフィールド値 "Cat" を既定値として取り扱い、シリアル化しません。フィールド値が "Cat" 以外の値に設定された場合は、 XmlSerializer がシリアル化を実行します。

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


' This is the class that will be serialized. 
Public Class Pet
    ' The default value for the Animal field is "Dog". 
    <DefaultValueAttribute("Dog")> Public Animal As String 
End Class


Public Class Run
    
    Public Shared Sub Main()
        Dim test As New Run()
        test.SerializeObject("OverrideDefaultValue.xml")
        test.DeserializeObject("OverrideDefaultValue.xml")
    End Sub 'Main
    
    
    ' Return an XmlSerializer used for overriding. 
    Public Function CreateOverrider() As XmlSerializer
        ' Create the XmlAttributeOverrides and XmlAttributes objects. 
        Dim xOver As New XmlAttributeOverrides()
        Dim xAttrs As New XmlAttributes()
        
        ' Add an override for the default value of the GroupName. 
        Dim defaultName As Object = "Cat"
        xAttrs.XmlDefaultValue = defaultName
        
        ' Add all the XmlAttributes to the XmlAttribueOverrides object. 
        xOver.Add(GetType(Pet), "Animal", xAttrs)
        
        ' Create the XmlSerializer and return it.
        Return New XmlSerializer(GetType(Pet), xOver)
    End Function
    
    
    Public Sub SerializeObject(ByVal filename As String)
       ' Create an instance of the XmlSerializer class.
       Dim mySerializer As XmlSerializer = CreateOverrider()
        
       ' Writing the file requires a TextWriter.
       Dim writer As New StreamWriter(filename)
        
       ' Create an instance of the class that will be serialized. 
       Dim myPet As New Pet()
        
       ' Set the Animal property. If you set it to the default value,
       ' which is "Cat" (the value assigned to the XmlDefaultValue
       ' of the XmlAttributes object), no value will be serialized.
       ' If you change the value to any other value (including "Dog"),
       ' the value will be serialized.

      ' The default value "Cat" will be assigned (nothing serialized).
      myPet.Animal = ""
      ' Uncommenting the next line also results in the default 
      ' value because Cat is the default value (not serialized).
      '  myPet.Animal = "Cat"; 
      
      ' Uncomment the next line to see the value serialized:
      ' myPet.Animal = "fish";
      ' This will also be serialized because Dog is not the 
      ' default anymore.
      '  myPet.Animal = "Dog";
       ' Serialize the class, and close the TextWriter.
        mySerializer.Serialize(writer, myPet)
        writer.Close()
    End Sub
    
    
    Public Sub DeserializeObject(ByVal filename As String)
        Dim mySerializer As XmlSerializer = CreateOverrider()
        Dim fs As New FileStream(filename, FileMode.Open)
        Dim myPet As Pet = CType(mySerializer.Deserialize(fs), Pet)
        Console.WriteLine(myPet.Animal)
    End Sub
End Class


[C#] 
using System; 
using System.IO; 
using System.Xml; 
using System.Xml.Serialization; 
using System.ComponentModel; 

// This is the class that will be serialized. 
public class Pet 
{
   // The default value for the Animal field is "Dog". 
   [DefaultValueAttribute("Dog")] 
   public string Animal ; 
} 

public class Run 
{ 
   public static void Main() 
   { 
      Run test = new Run();
      test.SerializeObject("OverrideDefaultValue.xml");
      test.DeserializeObject("OverrideDefaultValue.xml"); 
   }
 
   // Return an XmlSerializer used for overriding. 
   public XmlSerializer CreateOverrider() 
   { 
      // Create the XmlAttributeOverrides and XmlAttributes objects. 
      XmlAttributeOverrides xOver = new XmlAttributeOverrides(); 
      XmlAttributes xAttrs = new XmlAttributes(); 

      // Add an override for the default value of the GroupName. 
      Object defaultAnimal= "Cat";
      xAttrs.XmlDefaultValue = defaultAnimal; 

      // Add all the XmlAttributes to the XmlAttribueOverrides object. 
      xOver.Add(typeof(Pet), "Animal", xAttrs); 

      // Create the XmlSerializer and return it.
      return new XmlSerializer(typeof(Pet), xOver);
   }

   public void SerializeObject(string filename)
   {
      // Create an instance of the XmlSerializer class.
      XmlSerializer mySerializer = CreateOverrider(); 

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

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

      /* Set the Animal property. If you set it to the default value,
         which is "Cat" (the value assigned to the XmlDefaultValue
         of the XmlAttributes object), no value will be serialized.
         If you change the value to any other value (including "Dog"),
         the value will be serialized.
      */
      // The default value "Cat" will be assigned (nothing serialized).
      myPet.Animal= ""; 
      // Uncommenting the next line also results in the default 
      // value because Cat is the default value (not serialized).
      //  myPet.Animal = "Cat"; 
      
      // Uncomment the next line to see the value serialized:
      // myPet.Animal = "fish";
      // This will also be serialized because Dog is not the 
      // default anymore.
      //  myPet.Animal = "Dog";
      // Serialize the class, and close the TextWriter. 
      mySerializer.Serialize(writer, myPet); 
      writer.Close(); 
   } 

   public void DeserializeObject(string filename) 
   {
      XmlSerializer mySerializer = CreateOverrider();
      FileStream fs = new FileStream(filename, FileMode.Open);
      Pet myPet= (Pet)mySerializer.Deserialize(fs);
      Console.WriteLine(myPet.Animal);
   }
}


[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::ComponentModel; 

// This is the class that will be serialized. 
public __gc class Pet 
{
   // The default value for the Animal field is "Dog". 
public:
   [DefaultValueAttribute(S"Dog")] 
   String* Animal ; 
}; 

// Return an XmlSerializer used for overriding. 
XmlSerializer* CreateOverrider() 
{ 
   // Create the XmlAttributeOverrides and XmlAttributes objects. 
   XmlAttributeOverrides* xOver = new XmlAttributeOverrides(); 
   XmlAttributes* xAttrs = new XmlAttributes(); 

   // Add an override for the default value of the GroupName. 
   Object* defaultAnimal= S"Cat";
   xAttrs->XmlDefaultValue = defaultAnimal; 

   // Add all the XmlAttributes to the XmlAttribueOverrides object. 
   xOver->Add(__typeof(Pet), S"Animal", xAttrs); 

   // Create the XmlSerializer and return it.
   return new XmlSerializer(__typeof(Pet), xOver);
}

void SerializeObject(String* filename)
{
   // Create an instance of the XmlSerializer class.
   XmlSerializer* mySerializer = CreateOverrider(); 

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

   // Create an instance of the class that will be serialized. 
   Pet* myPet = new Pet(); 

   /* Set the Animal property. If you set it to the default value,
   which is "Cat" (the value assigned to the XmlDefaultValue
   of the XmlAttributes object), no value will be serialized.
   If you change the value to any other value (including "Dog"),
   the value will be serialized.
   */
   // The default value "Cat" will be assigned (nothing serialized).
   myPet->Animal= S""; 
   // Uncommenting the next line also results in the default 
   // value because Cat is the default value (not serialized).
   //  myPet.Animal = "Cat"; 

   // Uncomment the next line to see the value serialized:
   // myPet.Animal = "fish";
   // This will also be serialized because Dog is not the 
   // default anymore.
   //  myPet.Animal = "Dog";
   // Serialize the class, and close the TextWriter. 
   mySerializer->Serialize(writer, myPet); 
   writer->Close(); 
} 

void DeserializeObject(String* filename) 
{
   XmlSerializer* mySerializer = CreateOverrider();
   FileStream* fs = new FileStream(filename, FileMode::Open);
   Pet* myPet= dynamic_cast<Pet*>(mySerializer->Deserialize(fs));
   Console::WriteLine(myPet->Animal);
}

int main() 
{ 
   SerializeObject(S"OverrideDefaultValue.xml");
   DeserializeObject(S"OverrideDefaultValue.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 ファミリ

参照

XmlAttributes クラス | XmlAttributes メンバ | System.Xml.Serialization 名前空間

次の方法で共有

XmlAttributes.XmlDefaultValue プロパティ

プロパティ値

解説

使用例

必要条件

参照

その他のリソース