DataMemberAttribute.EmitDefaultValue Свойство

Определение

Пространство имен:

System.Runtime.Serialization

Сборка:

System.Runtime.Serialization.Primitives.dll

Исходный код:

DataMemberAttribute.cs

Возвращает или задает значение, указывающее, следует ли сериализовать значение по умолчанию сериализуемого поля или свойства.

public:
 property bool EmitDefaultValue { bool get(); void set(bool value); };

public bool EmitDefaultValue { get; set; }

member this.EmitDefaultValue : bool with get, set

Public Property EmitDefaultValue As Boolean

Значение свойства

Boolean

Значение true, если значение по умолчанию для элемента должно быть создано в потоке сериализации; в противном случае — значение false. Значение по умолчанию — true.

Примеры

В следующем примере показано, как свойству EmitDefaultValue задается значение false в разных полях.

[DataContract]
public class Employee
{
    // The CLR default for as string is a null value.
    // This will be written as <employeeName xsi:nill="true" />
    [DataMember]
    public string EmployeeName = null;

    // This will be written as <employeeID>0</employeeID>
    [DataMember]
    public int employeeID = 0;

    // The next three will not be written because the EmitDefaultValue = false.
    [DataMember(EmitDefaultValue = false)]
    public string position = null;
    [DataMember(EmitDefaultValue = false)]
    public int salary = 0;
    [DataMember(EmitDefaultValue = false)]
    public int? bonus = null;

    // This will be written as <targetSalary>57800</targetSalary>
    [DataMember(EmitDefaultValue = false)]
    public int targetSalary = 57800;
}

<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

Комментарии

На платформе .NET Framework типы имеют концепцию значений по умолчанию. Например, для любого ссылочного типа значением по умолчанию является null, а для целочисленного типа — 0. Иногда требуется исключить элемент данных из сериализованных данных, если для него задано значение по умолчанию. Для этого задайте свойству EmitDefaultValue значение false (по умолчанию свойство имеет значение true).

Примечание

Не рекомендуется задавать для свойства EmitDefaultValue значение false. Это следует делать только при конкретной необходимости, например для обеспечения взаимодействия или уменьшения размера данных.