JsonSerializerOptions クラス

定義

JsonSerializer で使用されるオプションを提供します。Provides options to be used with JsonSerializer.

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

注釈

詳細については、「JSON をシリアル化および逆シリアル化する方法」を参照してください。For more information, see How to serialize and deserialize JSON.

コンストラクター

JsonSerializerOptions()

JsonSerializerOptions クラスの新しいインスタンスを初期化します。Initializes a new instance of the JsonSerializerOptions class.

JsonSerializerOptions(JsonSerializerDefaults)

指定された JsonSerializerOptions によって決定されるオプションの定義済みのセットを使用して、JsonSerializerDefaults の新しいインスタンスを構築します。Constructs a new JsonSerializerOptions instance with a predefined set of options determined by the specified JsonSerializerDefaults.

JsonSerializerOptions(JsonSerializerOptions)

オプションを JsonSerializerOptions インスタンスから新しいインスタンスにコピーします。Copies the options from a JsonSerializerOptions instance to a new instance.

プロパティ

AllowTrailingCommas

逆シリアル化される JSON ペイロード内でオブジェクトまたは配列の JSON 値の一覧の終わりにある余分なコンマが許可 (および無視) されるかどうかを示す値を取得または設定します。Get or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being deserialized.

Converters

登録されたユーザー定義のコンバーターの一覧を取得します。Gets the list of user-defined converters that were registered.

DefaultBufferSize

一時バッファーの作成時に使用する、既定のバッファー サイズ (バイト単位) を取得または設定します。Gets or sets the default buffer size, in bytes, to use when creating temporary buffers.

DefaultIgnoreCondition

シリアル化または逆シリアル化の間に既定値を持つプロパティを無視するかどうかを決定する条件を指定します。Specifies a condition to determine when properties with default values are ignored during serialization or deserialization. 既定値は Never です。The default value is Never.

DictionaryKeyPolicy

IDictionary キーの名前を、camel 形式などの別の形式に変換するために使用されるポリシーを取得または設定します。Gets or sets the policy used to convert a IDictionary key's name to another format, such as camel-casing.

Encoder

文字列をエスケープするときに使用するエンコーダーを取得または設定します。既定のエンコーダーを使用する場合は null を設定します。Gets or sets the encoder to use when escaping strings, or null to use the default encoder.

IgnoreNullValues

シリアル化および逆シリアル化の間に null 値を無視するかどうかを決定する値を取得または設定します。Gets or sets a value that determines whether null values are ignored during serialization and deserialization. 既定値は false です。The default value is false.

IgnoreReadOnlyFields

シリアル化の間に読み取り専用フィールドを無視するかどうかを指定します。Determines whether read-only fields are ignored during serialization. readonly キーワードでマークされていないプロパティは、読み取り専用です。A property is read-only if it isn't marked with the readonly keyword. 既定値は false です。The default value is false.

IgnoreReadOnlyProperties

シリアル化中に読み取り専用プロパティを無視するかどうかを決定する値を取得します。Gets a value that determines whether read-only properties are ignored during serialization. 既定値は false です。The default value is false.

IncludeFields

フィールドがシリアル化と逆シリアル化で処理されるかどうかを決定します。Determines whether fields are handled serialization and deserialization. 既定値は false です。The default value is false.

MaxDepth

JSON をシリアル化または逆シリアル化するときに許容される最大の深さを取得または設定します。既定値は 0 で、最大の深さが 64 であることを示します。Gets or sets the maximum depth allowed when serializing or deserializing JSON, with the default value of 0 indicating a maximum depth of 64.

NumberHandling

シリアル化または逆シリアル化のときに数値型を処理する方法を指定します。Specifies how number types should be handled when serializing or deserializing.

PropertyNameCaseInsensitive

逆シリアル化中に、プロパティの名前で大文字と小文字を区別しない比較が使用されるかどうかを決定する値を取得または設定します。Gets or sets a value that determines whether a property's name uses a case-insensitive comparison during deserialization. 既定値は false です。The default value is false.

PropertyNamingPolicy

オブジェクトのプロパティの名前を、キャメルケース形式などの別の形式に変換するために使用されるポリシーを指定する値を取得または設定するか、プロパティ名を変更しない場合は null にします。Gets or sets a value that specifies the policy used to convert a property's name on an object to another format, such as camel-casing, or null to leave property names unchanged.

ReadCommentHandling

逆シリアル化中にコメントを処理する方法を定義する値を取得または設定します。Gets or sets a value that defines how comments are handled during deserialization.

ReferenceHandler

JSON の読み取りおよび書き込み時に、オブジェクト参照がどのように処理されるかを構成します。Configures how object references are handled when reading and writing JSON.

WriteIndented

JSON で整形出力を使用する必要があるかどうかを定義する値を取得または設定します。Gets or sets a value that defines whether JSON should use pretty printing. 既定では、JSON は余分な空白なしでシリアル化されます。By default, JSON is serialized without any extra white space.

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetConverter(Type)

指定された型のコンバーターを返します。Returns the converter for the specified type.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象