Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

JsonSerializerOptions.IgnoreReadOnlyFields Property

Definition

Namespace:
System.Text.Json
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v11.0.0-preview.5.26302.115
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value that indicates whether read-only fields are ignored during serialization. A field is read-only if it is marked with the readonly keyword. The default value is false.

public:
 property bool IgnoreReadOnlyFields { bool get(); void set(bool value); };
public bool IgnoreReadOnlyFields { get; set; }
member this.IgnoreReadOnlyFields : bool with get, set
Public Property IgnoreReadOnlyFields As Boolean

Property Value

true if read-only fields are ignored during serialization; false otherwise.

Exceptions

This property is set after serialization or deserialization has occurred.

Remarks

Read-only fields are not deserialized regardless of this setting.

Applies to


Feedback

Was this page helpful?