Export (0) Print
Expand All

XmlAttributes.XmlDefaultValue Property

Gets or sets the default value of an XML element or attribute.

Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)

public:
property Object^ XmlDefaultValue {
	Object^ get ();
	void set (Object^ value);
}
/** @property */
public Object get_XmlDefaultValue ()

/** @property */
public void set_XmlDefaultValue (Object value)

public function get XmlDefaultValue () : Object

public function set XmlDefaultValue (value : Object)

Property Value

An Object that represents the default value of an XML element or attribute.

You can specify the default value of an XML element or XML attribute by applying a DefaultValueAttribute to a member. To examine the result of applying the value, compile the application into a DLL or executable, and pass the resulting file as an argument to the XML Schema Definition tool (XSD.exe). In the XML schema document, a default value is assigned to the default attribute. In the following example, the default for the <Animal> element is "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>

To override the default value, create an Object and assign it to the XmlDefaultValue.

If the value assigned to a field or property is equal to the default value for that field or property, the XmlSerializer does not serialize the value to the XML-instance. This is because the assigned value can be recovered from the XML schema. In other words, setting a field or property to its own default value is equivalent of not setting it at all. Likewise, if no value is set for the field or property, the XmlSerializer uses the default value found in the schema. In both cases, (setting the property to its default, or not setting it at all), the XML-document instance does not contain any value for the property.

You can use the class constructors instead of the schema to assign the default values. If you are using Xsd.exe to generate a classes from schemas, you can comment out or remove all of the [System.ComponentModel.DefaultValueAttribute("myFieldName")] attributes from the class files.

The following example shows a class named Pet that contains a field that has a default value set to "Dog". However, the example also creates an XmlAttributes object, and sets its XmlDefaultValue property to a new default value ("Cat"). This overrides the original default value. Thus, if the field value is set to "Cat", the XmlSerializer treats it as the default value, and not serialize it. If it is set to any other value, the XmlSerializer serializes the value.

#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 ref class Pet
{
public:

   // The default value for the Animal field is "Dog". 

   [DefaultValueAttribute("Dog")]
   String^ Animal;
};

// Return an XmlSerializer used for overriding. 
XmlSerializer^ CreateOverrider()
{
   // Create the XmlAttributeOverrides and XmlAttributes objects. 
   XmlAttributeOverrides^ xOver = gcnew XmlAttributeOverrides;
   XmlAttributes^ xAttrs = gcnew 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( Pet::typeid, "Animal", xAttrs );

   // Create the XmlSerializer and return it.
   return gcnew XmlSerializer( Pet::typeid,xOver );
}

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

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

   // Create an instance of the class that will be serialized. 
   Pet^ myPet = gcnew 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();
}

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

int main()
{
   SerializeObject( "OverrideDefaultValue.xml" );
   DeserializeObject( "OverrideDefaultValue.xml" );
}

import System.*;
import System.IO.*;
import System.Xml.*;
import System.Xml.Serialization.*;
import System.ComponentModel.*;

// This is the class that will be serialized. 
public class Pet
{
    // The default value for the Animal field is "Dog". 
    /** @attribute DefaultValueAttribute("Dog")
     */
    public String animal;
} //Pet

public class Run
{
    public static void main(String[] args)
    {
        Run test = new Run();
        test.SerializeObject("OverrideDefaultValue.xml");
        test.DeserializeObject("OverrideDefaultValue.xml");
    } //main

    // 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.set_XmlDefaultValue(defaultAnimal);

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

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

    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();
    } //SerializeObject

    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);
    } //DeserializeObject
} //Run

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft