Utf8JsonWriter.WritePropertyName Method
Definition
Namespace: Corvus.Text.Json
Assembly: Corvus.Text.Json.dll
Overloads
| Method | Description |
|---|---|
| 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<char>) | 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(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(JsonEncodedText propertyName)
Parameters
| Name | Type | Description |
|---|---|---|
propertyName |
JsonEncodedText |
The JSON-encoded name of the property to write. |
Exceptions
| Exception | Description |
|---|---|
InvalidOperationException |
Thrown if this would result in invalid JSON being written (while validation is enabled). |
Applies To
| Product | Versions |
|---|---|
| .NET | 9, 10 |
| .NET Standard | 2.0, 2.1 |
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(string propertyName)
Parameters
| Name | Type | Description |
|---|---|---|
propertyName |
string |
The name of the property to write. |
Exceptions
| Exception | Description |
|---|---|
ArgumentException |
Thrown when the specified property name is too large. |
ArgumentNullException |
The propertyName parameter is null. |
InvalidOperationException |
Thrown if this would result in invalid JSON being written (while validation is enabled). |
Remarks
The property name is escaped before writing.
Applies To
| Product | Versions |
|---|---|
| .NET | 9, 10 |
| .NET Standard | 2.0, 2.1 |
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)
Parameters
| Name | Type | Description |
|---|---|---|
propertyName |
ReadOnlySpan<char> |
The name of the property to write. |
Exceptions
| Exception | Description |
|---|---|
ArgumentException |
Thrown when the specified property name is too large. |
InvalidOperationException |
Thrown if this would result in invalid JSON being written (while validation is enabled). |
Remarks
The property name is escaped before writing.
Applies To
| Product | Versions |
|---|---|
| .NET | 9, 10 |
| .NET Standard | 2.0, 2.1 |
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<byte> utf8PropertyName)
Parameters
| Name | Type | Description |
|---|---|---|
utf8PropertyName |
ReadOnlySpan<byte> |
The UTF-8 encoded name of the property to write. |
Exceptions
| Exception | Description |
|---|---|
ArgumentException |
Thrown when the specified property name is too large. |
InvalidOperationException |
Thrown if this would result in invalid JSON being written (while validation is enabled). |
Remarks
The property name is escaped before writing.
Applies To
| Product | Versions |
|---|---|
| .NET | 9, 10 |
| .NET Standard | 2.0, 2.1 |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests.
Open an issue