Utf8JsonWriter.WriteStartObject Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Overloads

WriteStartObject(JsonEncodedText)	Writes the beginning of a JSON object with a pre-encoded property name as the key.
WriteStartObject(ReadOnlySpan<Char>)	Writes the beginning of a JSON object with a property name specified as a read-only character span as the key.
WriteStartObject(String)	Writes the beginning of a JSON object with a property name specified as a string as the key.
WriteStartObject()	Writes the beginning of a JSON object.
WriteStartObject(ReadOnlySpan<Byte>)	Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key.

WriteStartObject(JsonEncodedText)

Source:

Utf8JsonWriter.cs

Writes the beginning of a JSON object with a pre-encoded property name as the key.

C#

public void WriteStartObject(System.Text.Json.JsonEncodedText propertyName);

Parameters

propertyName

JsonEncodedText

The JSON encoded property name of the JSON object to be transcoded and written as UTF-8.

Exceptions

InvalidOperationException

The depth of the JSON has exceeded the maximum depth of 1,000.

-or-

Validation is enabled, and this method would result in writing invalid JSON.

Remarks

The property name should already be escaped when the instance of JsonEncodedText was created.

WriteStartObject(ReadOnlySpan<Char>)

Source:

Utf8JsonWriter.cs

Writes the beginning of a JSON object with a property name specified as a read-only character span as the key.

C#

public void WriteStartObject(ReadOnlySpan<char> propertyName);

Parameters

propertyName

ReadOnlySpan<Char>

The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.

Exceptions

ArgumentException

The specified property name is too large.

InvalidOperationException

The depth of the JSON exceeds the maximum depth of 1,000.

-or-

Validation is enabled, and this write operation would produce invalid JSON.

Remarks

The property name is escaped before writing.

WriteStartObject(String)

Source:

Utf8JsonWriter.cs

Writes the beginning of a JSON object with a property name specified as a string as the key.

C#

public void WriteStartObject(string propertyName);

Parameters

propertyName

String

The UTF-16 encoded property name of the JSON object to be transcoded and written as UTF-8.

Exceptions

ArgumentException

The specified property name is too large.

InvalidOperationException

The depth of the JSON exceeds the maximum depth of 1,000.

-or-

Validation is enabled, and this write operation would produce invalid JSON.

ArgumentNullException

The propertyName parameter is null.

Remarks

The property name is escaped before writing.

WriteStartObject()

Source:

Utf8JsonWriter.cs

Writes the beginning of a JSON object.

C#

public void WriteStartObject();

Exceptions

InvalidOperationException

The depth of the JSON exceeds the maximum depth of 1,000.

-or-

Validation is enabled, and the operation would result in writing invalid JSON.

WriteStartObject(ReadOnlySpan<Byte>)

Source:

Utf8JsonWriter.cs

Writes the beginning of a JSON object with a property name specified as a read-only span of bytes as the key.

C#

public void WriteStartObject(ReadOnlySpan<byte> utf8PropertyName);

Parameters

utf8PropertyName

ReadOnlySpan<Byte>

The UTF-8 encoded property name of the JSON object to be written.

Exceptions

ArgumentException

The specified property name is too large.

InvalidOperationException

The depth of the JSON exceeds the maximum depth of 1,000.

-or-

Validation is enabled, and this write operation would produce invalid JSON.

Remarks

The property name is escaped before writing.