JsonSerializerOptions クラス

定義

JsonSerializerで使用するオプションを提供します。

public ref class JsonSerializerOptions sealed
public sealed class JsonSerializerOptions
type JsonSerializerOptions = class
Public NotInheritable Class JsonSerializerOptions
継承
JsonSerializerOptions

注釈

詳細については、「 JSON をシリアル化および逆シリアル化する方法」を参照してください。

コンストラクター

名前 説明
JsonSerializerOptions()

JsonSerializerOptions クラスの新しいインスタンスを初期化します。

JsonSerializerOptions(JsonSerializerDefaults)

指定したJsonSerializerDefaultsによって決まる定義済みのオプション セットを使用して、新しいJsonSerializerOptions インスタンスを構築します。

JsonSerializerOptions(JsonSerializerOptions)

JsonSerializerOptions インスタンスから新しいインスタンスにオプションをコピーします。

プロパティ

名前 説明
AllowDuplicateProperties

JSON オブジェクトの逆シリアル化時に重複するプロパティ名を許可するかどうかを示す値を取得または設定します。

AllowOutOfOrderMetadataProperties

逆シリアル化された JSON オブジェクトの通常のプロパティの後に JSON メタデータ プロパティを指定できるかどうかを示す値を取得または設定します。

AllowTrailingCommas

逆シリアル化される JSON ペイロード内で、オブジェクトまたは配列内の JSON 値の一覧の末尾に余分なコンマを使用できるかどうかを示す値を取得または設定します。

Converters

登録されたユーザー定義コンバーターの一覧を取得します。

Default

既定の構成を使用する JsonSerializerOptions の読み取り専用のシングルトン インスタンスを取得します。

DefaultBufferSize

一時バッファーの作成時に使用する既定のバッファー サイズ (バイト単位) を取得または設定します。

DefaultIgnoreCondition

シリアル化または逆シリアル化中に既定値を持つプロパティが無視されるタイミングを決定する値を取得または設定します。 既定値は Never です。

DictionaryKeyPolicy

IDictionary キーの名前をキャメル ケースなどの別の形式に変換するために使用するポリシーを取得または設定します。

Encoder

文字列をエスケープするときに使用するエンコーダー、または既定のエンコーダーを使用する null を取得または設定します。

IgnoreNullValues
古い.

シリアル化および逆シリアル化中に null 値が無視されるかどうかを示す値を取得または設定します。 既定値は false です。

IgnoreReadOnlyFields

シリアル化中に読み取り専用フィールドが無視されるかどうかを示す値を取得または設定します。 フィールドが readonly キーワードでマークされている場合、フィールドは読み取り専用です。 既定値は false です。

IgnoreReadOnlyProperties

シリアル化中に読み取り専用プロパティが無視されるかどうかを示す値を取得または設定します。 既定値は false です。

IncludeFields

シリアル化と逆シリアル化の間にフィールドを処理するかどうかを示す値を取得または設定します。 既定値は false です。

IndentCharacter

WriteIndentedが有効な場合に使用されるインデント文字を定義します。 既定値はスペース文字です。

IndentSize

WriteIndentedが有効な場合に使用されるインデント サイズを定義します。 既定値は 2 です。

IsReadOnly

現在のインスタンスがユーザー変更のためにロックされているかどうかを示す値を取得します。

MaxDepth

JSON をシリアル化または逆シリアル化するときに許容される最大深度を取得または設定します。既定値は 0 で、最大深度は 64 です。

NewLine

WriteIndentedtrueされたときに使用する新しい行文字列を取得または設定します。

既定値は、NewLine の値です。

NumberHandling

シリアル化または逆シリアル化するときに数値型を処理する方法を指定するオブジェクトを取得または設定します。

PreferredObjectCreationHandling

JSON を逆シリアル化するときのプロパティの優先オブジェクト作成処理を取得または設定します。

PropertyNameCaseInsensitive

逆シリアル化中にプロパティの名前で大文字と小文字が区別されない比較を使用するかどうかを示す値を取得または設定します。 既定値は false です。

PropertyNamingPolicy

オブジェクトのプロパティ名を別の形式 (キャメルケースなど) に変換したり、プロパティ名を変更しない null に使用するポリシーを指定する値を取得または設定します。

ReadCommentHandling

逆シリアル化中のコメントの処理方法を定義する値を取得または設定します。

ReferenceHandler

JSON の読み取りと書き込み時のオブジェクト参照の処理方法を指定するオブジェクトを取得または設定します。

RespectNullableAnnotations

シリアル化と逆シリアル化の間に null 許容注釈を考慮する必要があるかどうかを示す値を取得または設定します。

RespectRequiredConstructorParameters

逆シリアル化中にオプション以外のコンストラクター パラメーターを指定する必要があるかどうかを示す値を取得または設定します。

Strict

厳密な構成を使用する JsonSerializerOptions の読み取り専用のシングルトン インスタンスを取得します。

TypeInfoResolver

このインスタンスで使用される JsonTypeInfo コントラクト リゾルバーを取得または設定します。

TypeInfoResolverChain

このインスタンスで使用されるチェーン JsonTypeInfo コントラクト リゾルバーの一覧を取得します。

UnknownTypeHandling

逆シリアル化中に Object として宣言された型の逆シリアル化の処理方法を指定するオブジェクトを取得または設定します。

UnmappedMemberHandling

オブジェクト型を逆シリアル化するときに特定の.NET メンバーにマップできない JSON プロパティJsonSerializer が処理する方法を指定するオブジェクトを取得または設定します。

Web

Web 構成を使用する JsonSerializerOptions の読み取り専用のシングルトン インスタンスを取得します。

WriteIndented

JSON で整形印刷を使用する必要があるかどうかを示す値を取得または設定します。 既定では、JSON は余分な空白なしでシリアル化されます。

メソッド

名前 説明
AddContext<TContext>()
古い.

現在のJsonSerializerOptions インスタンスのメタデータ解決に新しいJsonSerializerContextを追加します。

Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetConverter(Type)

指定した型のコンバーターを返します。

GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
GetTypeInfo(Type)

現在のJsonSerializerOptions インスタンスによって解決されたJsonTypeInfo コントラクト メタデータを取得します。

GetTypeInfo<T>()

JsonSerializerで使用するオプションを提供します。

MakeReadOnly()

現在のインスタンスを読み取り専用としてマークし、ユーザーの変更を防ぎます。

MakeReadOnly(Boolean)

現在のインスタンスを読み取り専用としてマークし、ユーザーの変更を防止します。

MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
TryGetTypeInfo(Type, JsonTypeInfo)

現在のJsonSerializerOptions インスタンスによって解決されたJsonTypeInfo コントラクト メタデータの取得を試みます。

TryGetTypeInfo<T>(JsonTypeInfo<T>)

JsonSerializerで使用するオプションを提供します。

拡張メソッド

名前 説明
AddAIContentType(JsonSerializerOptions, Type, String)

AIContentのポリモーフィックな構成にカスタム コンテンツ タイプを追加します。

AddAIContentType<TContent>(JsonSerializerOptions, String)

AIContentのポリモーフィックな構成にカスタム コンテンツ タイプを追加します。

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

指定した型のコントラクト メタデータに対応する JSON スキーマを生成します。

適用対象