DataMemberAttribute.EmitDefaultValue DataMemberAttribute.EmitDefaultValue DataMemberAttribute.EmitDefaultValue DataMemberAttribute.EmitDefaultValue Property

Definition

シリアル化されるフィールドまたはプロパティのデフォルト値をシリアル化するかどうかを指定する値を取得または設定します。 Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized.

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

Property Value

メンバーのデフォルト値をシリアル化ストリームの中で生成する必要がある場合は true。それ以外の場合は false true if the default value for a member should be generated in the serialization stream; otherwise, false. 既定値は、true です。 The default is true.

Examples

さまざまなフィールドで EmitDefaultValue プロパティを false に設定する例を次に示します。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: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 

Remarks

.NET Framework.NET Framework では、型に既定値の概念があります。In the .NET Framework.NET Framework, types have a concept of default values. たとえば、既定値は任意の参照型null整数型の場合は 0。For example, for any reference type the default value is null, 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. これを行うには、EmitDefaultValue プロパティを false に設定します (既定では true が設定されます)。To do this, set the EmitDefaultValue property to false (it is true by default).

注意

EmitDefaultValue プロパティを false に設定することは、お勧めしません。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).

Applies to