JsonSerializerOptions.IgnoreReadOnlyProperties Property

  • Reference

Definition

Namespace:
System.Text.Json
Assembly:
System.Text.Json.dll
Package:
System.Text.Json v8.0.5
Package:
System.Text.Json v9.0.0-rc.2.24473.5
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs
Source:
JsonSerializerOptions.cs

Gets or sets a value that indicates whether read-only properties are ignored during serialization. The default value is false.

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

Property Value

Boolean

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

Exceptions

InvalidOperationException

This property was set after serialization or deserialization has occurred.

Remarks

A property is read-only if it contains a public getter but not a public setter.

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

For more information, see How to ignore properties with System.Text.Json.

Applies to