Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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)
member XmlDefaultValue : Object with get, set

Property Value

Type: System.Object
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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft. All rights reserved.