DataMemberAttribute.EmitDefaultValue Eigenschap

Definitie

Naamruimte:

System.Runtime.Serialization

Assembly:

System.Runtime.Serialization.dll

Hiermee wordt een waarde opgehaald of ingesteld waarmee wordt aangegeven of de standaardwaarde moet worden geserialiseerd voor een veld of eigenschap die wordt geserialiseerd.

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

Waarde van eigenschap

Boolean

true als de standaardwaarde voor een lid moet worden gegenereerd in de serialisatiestroom; anders, false. De standaardwaarde is true.

Voorbeelden

In het volgende voorbeeld ziet u de EmitDefaultValue eigenschap die is ingesteld false op verschillende velden.

[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

Opmerkingen

In het .NET Framework hebben typen een concept van standaardwaarden. Voor elk verwijzingstype is nullde standaardwaarde bijvoorbeeld 0 voor een geheel getal. Het is af en toe wenselijk om een gegevenslid weg te laten van de geserialiseerde gegevens wanneer deze is ingesteld op de standaardwaarde. Hiervoor stelt u de EmitDefaultValue eigenschap in op false (deze is true standaard).

Note

Het instellen van de EmitDefaultValue eigenschap false is geen aanbevolen procedure. Dit moet alleen worden gedaan als er een specifieke noodzaak is om dit te doen (zoals voor interoperabiliteit of om de gegevensgrootte te verkleinen).