JsonSerializerOptions.WriteIndented 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 JSON should use pretty printing. By default, JSON is serialized without any extra white space.

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

public bool WriteIndented { get; set; }

member this.WriteIndented : bool with get, set

Public Property WriteIndented As Boolean

Property Value

Boolean

true if JSON is pretty printed on serialization; otherwise, false. The default is false.

Exceptions

InvalidOperationException

This property was set after serialization or deserialization has occurred.

Remarks

Pretty printing includes:

• Indenting nested JSON tokens.
• Adding new lines
• Adding white space between property names and values.

For more information, see How to serialize and deserialize JSON.