Utf8JsonWriter.WritePropertyName Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

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

Overloads

WritePropertyName(JsonEncodedText)	Writes the pre-encoded property name (as a JSON string) as the first part of a name/value pair of a JSON object.
WritePropertyName(String)	Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.
WritePropertyName(ReadOnlySpan<Byte>)	Writes the UTF-8 property name (as a JSON string) as the first part of a name/value pair of a JSON object.
WritePropertyName(ReadOnlySpan<Char>)	Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.

WritePropertyName(JsonEncodedText)

Source:

Utf8JsonWriter.WriteProperties.String.cs

Writes the pre-encoded property name (as a JSON string) as the first part of a name/value pair of a JSON object.

public:
 void WritePropertyName(System::Text::Json::JsonEncodedText propertyName);

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

member this.WritePropertyName : System.Text.Json.JsonEncodedText -> unit

Public Sub WritePropertyName (propertyName As JsonEncodedText)

Parameters

propertyName

JsonEncodedText

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

Exceptions

InvalidOperationException

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

Remarks

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

WritePropertyName(String)

Source:

Utf8JsonWriter.WriteProperties.String.cs

Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.

public:
 void WritePropertyName(System::String ^ propertyName);

public void WritePropertyName (string propertyName);

member this.WritePropertyName : string -> unit

Public Sub WritePropertyName (propertyName As String)

Parameters

propertyName

String

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

Exceptions

ArgumentException

The specified property name is too large.

InvalidOperationException

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

ArgumentNullException

propertyName is null.

Remarks

The property name is escaped before writing.

WritePropertyName(ReadOnlySpan<Byte>)

Source:

Utf8JsonWriter.WriteProperties.String.cs

Writes the UTF-8 property name (as a JSON string) as the first part of a name/value pair of a JSON object.

public:
 void WritePropertyName(ReadOnlySpan<System::Byte> utf8PropertyName);

public void WritePropertyName (ReadOnlySpan<byte> utf8PropertyName);

member this.WritePropertyName : ReadOnlySpan<byte> -> unit

Public Sub WritePropertyName (utf8PropertyName As ReadOnlySpan(Of Byte))

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

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

Remarks

The property name is escaped before writing.

WritePropertyName(ReadOnlySpan<Char>)

Source:

Utf8JsonWriter.WriteProperties.String.cs

Writes the property name (as a JSON string) as the first part of a name/value pair of a JSON object.

public:
 void WritePropertyName(ReadOnlySpan<char> propertyName);

public void WritePropertyName (ReadOnlySpan<char> propertyName);

member this.WritePropertyName : ReadOnlySpan<char> -> unit

Public Sub WritePropertyName (propertyName As ReadOnlySpan(Of Char))

Parameters

propertyName

ReadOnlySpan<Char>

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

Exceptions

ArgumentException

The specified property name is too large.

InvalidOperationException

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

Remarks

The property name is escaped before writing.