EmitDefaultValue Property
Collapse the table of content
Expand the table of content

DataMemberAttribute.EmitDefaultValue Property

Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized.

Namespace: System.Runtime.Serialization
Assembly: System.Runtime.Serialization (in system.runtime.serialization.dll)

'Declaration
Public Property EmitDefaultValue As Boolean
'Usage
Dim instance As DataMemberAttribute
Dim value As Boolean

value = instance.EmitDefaultValue

instance.EmitDefaultValue = value
/** @property */
public boolean get_EmitDefaultValue ()

/** @property */
public void set_EmitDefaultValue (boolean value)

public function get EmitDefaultValue () : boolean

public function set EmitDefaultValue (value : boolean)

Not applicable.

Property Value

true if the default value for a member should be generated in the serialization stream; otherwise, false. The default is true.

In the .NET Framework, types have a concept of default values. For example, for any reference type the default value is a null reference (Nothing in Visual Basic), and for an integer type it is 0. It is occasionally desirable to omit a data member from the serialized data when it is set to its default value. To do this, set the EmitDefaultValue property to false (it is true by default).

NoteNote:

Setting the EmitDefaultValue property to false is not a recommended practice. It should only be done if there is a specific need to do so (such as for interoperability or to reduce data size).

The following example shows the EmitDefaultValue property set to false on various fields.

<DataContract()>  _
Public Class Employee
    ' The CLR default for as string is a null value.
    ' This will be written as <employeeName xsi:nil="true" />
    <DataMember()>  _
    Public employeeName As String = Nothing
    
    ' This will be written as <employeeID>0</employeeID>
    <DataMember()>  _
    Public employeeID As Integer = 0
    
    ' The next two will not be written because the EmitDefaultValue = false.
    <DataMember(EmitDefaultValue := False)> Public position As String = Nothing
    <DataMember(EmitDefaultValue := False)> Public salary As Integer = 0

    ' This will be written as <targetSalary>555</targetSalary> because 
    ' the 555 does not match the .NET default of 0.
    <DataMember(EmitDefaultValue := False)> Public targetSalary As Integer = 555
End Class 

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2016 Microsoft