JsonSerializerOptions.IncludeFields Property

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Source:

JsonSerializerOptions.cs

Gets or sets a value that indicates whether fields are handled during serialization and deserialization. The default value is false.

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

public bool IncludeFields { get; set; }

member this.IncludeFields : bool with get, set

Public Property IncludeFields As Boolean

Property Value

Boolean

true if public fields are included during serialization; otherwise, false.

Exceptions

InvalidOperationException

This property is set after serialization or deserialization has occurred.

Remarks

This flag only enables serialization for public fields, as is the case for properties. Private members need to be opted into individually using the JsonIncludeAttribute attribute.