JsonConverter<T>.ReadAsPropertyName Method

Reference

Definition

Namespace:: System.Text.Json.Serialization

Assembly:: System.Text.Json.dll

Package:: System.Text.Json v9.0.0

Source:: JsonConverterOfT.cs

Source:: JsonConverterOfT.cs

Source:: JsonConverterOfT.cs

Source:: JsonConverterOfT.cs

Source:: JsonConverterOfT.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Reads a dictionary key from a JSON property name.

public:
 virtual T ReadAsPropertyName(System::Text::Json::Utf8JsonReader % reader, Type ^ typeToConvert, System::Text::Json::JsonSerializerOptions ^ options);

public virtual T ReadAsPropertyName (ref System.Text.Json.Utf8JsonReader reader, Type typeToConvert, System.Text.Json.JsonSerializerOptions options);

abstract member ReadAsPropertyName : Utf8JsonReader * Type * System.Text.Json.JsonSerializerOptions -> 'T
override this.ReadAsPropertyName : Utf8JsonReader * Type * System.Text.Json.JsonSerializerOptions -> 'T

Public Overridable Function ReadAsPropertyName (ByRef reader As Utf8JsonReader, typeToConvert As Type, options As JsonSerializerOptions) As T

Parameters

reader: Utf8JsonReader

The Utf8JsonReader to read from.

typeToConvert: Type

The type to convert.

options: JsonSerializerOptions

The options to use when reading the value.

Returns

The value that was converted.

Remarks

This method should be overridden in custom converters of types used in deserialized dictionary keys.

Applies to

Jaa