DataMemberAttribute.EmitDefaultValue Propriedade

Definição

Namespace:

System.Runtime.Serialization

Assembly:

System.Runtime.Serialization.Primitives.dll

Origem:

DataMemberAttribute.cs

Obtém ou define um valor que especifica se o valor padrão deve ser serializado para um campo ou uma propriedade que está sendo serializada.

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

Valor da propriedade

Boolean

true se o valor padrão de um membro precisar ser gerado no fluxo de serialização; caso contrário, false. O padrão é true.

Exemplos

O exemplo a seguir mostra a EmitDefaultValue propriedade definida false como em vários campos.

[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

Comentários

No .NET Framework, os tipos têm um conceito de valores padrão. Por exemplo, para qualquer tipo de referência, o valor padrão é nulle, para um tipo inteiro, é 0. Ocasionalmente, é desejável omitir um membro de dados dos dados serializados quando eles são definidos como seu valor padrão. Para fazer isso, defina a EmitDefaultValue propriedade false como (ela é true por padrão).

Observação

Definir a EmitDefaultValue propriedade como false não é uma prática recomendada. Isso só deverá ser feito se houver uma necessidade específica de fazer isso (como para interoperabilidade ou para reduzir o tamanho dos dados).