Freigeben über


JsonSerializerOptions Klasse

Definition

Stellt Optionen bereit, die mit JsonSerializerverwendet werden sollen.

public ref class JsonSerializerOptions sealed
public sealed class JsonSerializerOptions
type JsonSerializerOptions = class
Public NotInheritable Class JsonSerializerOptions
Vererbung
JsonSerializerOptions

Hinweise

Weitere Informationen finden Sie unter How to serialize and deserialize JSON.

Konstruktoren

JsonSerializerOptions()

Initialisiert eine neue Instanz der JsonSerializerOptions Klasse.

JsonSerializerOptions(JsonSerializerDefaults)

Erstellt eine neue JsonSerializerOptions Instanz mit einem vordefinierten Satz von Optionen, die durch die angegebene JsonSerializerDefaultsbestimmt werden.

JsonSerializerOptions(JsonSerializerOptions)

Kopiert die Optionen aus einer JsonSerializerOptions Instanz in eine neue Instanz.

Eigenschaften

AllowOutOfOrderMetadataProperties

Ermöglicht die Angabe von JSON-Metadateneigenschaften nach regulären Eigenschaften in einem deserialisierten JSON-Objekt.

AllowTrailingCommas

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob ein zusätzliches Komma am Ende einer Liste von JSON-Werten in einem Objekt oder Array zulässig (und ignoriert) innerhalb der JSON-Nutzlast deserialisiert wird.

Converters

Ruft die Liste der benutzerdefinierten Konverter ab, die registriert wurden.

Default

Ruft eine schreibgeschützte Singletoninstanz von JsonSerializerOptions ab, die die Standardkonfiguration verwendet.

DefaultBufferSize

Ruft die Standardpuffergröße in Bytes ab, die beim Erstellen temporärer Puffer verwendet werden soll, oder legt diese fest.

DefaultIgnoreCondition

Dient zum Abrufen oder Festlegen eines Werts, der bestimmt, wann Eigenschaften mit Standardwerten während der Serialisierung oder Deserialisierung ignoriert werden. Der Standardwert ist Never.

DictionaryKeyPolicy

Ruft die Richtlinie ab, die zum Konvertieren des Namens eines IDictionary Schlüssels in ein anderes Format verwendet wird, z. B. kamelweise.

Encoder

Ruft den Encoder ab, der beim Escapen von Zeichenfolgen verwendet werden soll, oder legt diesen fest, oder null legt diesen fest, um den Standard-Encoder zu verwenden.

IgnoreNullValues
Veraltet.

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob null Werte während der Serialisierung und Deserialisierung ignoriert werden. Der Standardwert ist false.

IgnoreReadOnlyFields

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob schreibgeschützte Felder während der Serialisierung ignoriert werden. Ein Feld ist schreibgeschützt, wenn es mit dem schlüsselwort readonly markiert ist. Der Standardwert ist false.

IgnoreReadOnlyProperties

Ruft einen Wert ab, der angibt, ob schreibgeschützte Eigenschaften während der Serialisierung ignoriert werden. Der Standardwert ist false.

IncludeFields

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Felder während der Serialisierung und Deserialisierung behandelt werden. Der Standardwert ist false.

IndentCharacter

Definiert das Einzugszeichen, das verwendet wird, wenn WriteIndented aktiviert ist. Standardmäßig wird das Leerzeichen verwendet.

IndentSize

Definiert die Größe des Einzugs, die verwendet wird, wenn WriteIndented aktiviert ist. Standardwert ist 2.

IsReadOnly

Ruft einen Wert ab, der angibt, ob die aktuelle Instanz für die Benutzeränderung gesperrt wurde.

MaxDepth

Ruft die maximale Tiefe ab, die beim Serialisieren oder Deserialisieren von JSON zulässig ist, mit dem Standardwert 0, der eine maximale Tiefe von 64 angibt.

NewLine

Ruft die neue Zeilenzeichenfolge ab, die verwendet werden soll, wenn WriteIndentedtrueist, oder legt diese fest.

Der Standardwert ist der Wert von NewLine.

NumberHandling

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie Zahlentypen beim Serialisieren oder Deserialisieren behandelt werden sollen.

PreferredObjectCreationHandling

Ruft die bevorzugte Objekterstellungsbehandlung für Eigenschaften ab, wenn JSON deserialisiert wird, oder legt diese fest.

PropertyNameCaseInsensitive

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Name einer Eigenschaft während der Deserialisierung einen Vergleich zwischen Groß- und Kleinschreibung verwendet. Der Standardwert ist false.

PropertyNamingPolicy

Dient zum Abrufen oder Festlegen eines Werts, der die Richtlinie angibt, mit der der Name einer Eigenschaft für ein Objekt in ein anderes Format konvertiert wird, z. B. kamelweise oder null, eigenschaftennamen unverändert zu lassen.

ReadCommentHandling

Dient zum Abrufen oder Festlegen eines Werts, der definiert, wie Kommentare während der Deserialisierung behandelt werden.

ReferenceHandler

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie Objektverweise beim Lesen und Schreiben von JSON behandelt werden.

RespectNullableAnnotations

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Anmerkungen zur Nullierbarkeit während der Serialisierung und Deserialisierung berücksichtigt werden sollen.

RespectRequiredConstructorParameters

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob nicht optionale Konstruktorparameter während der Deserialisierung angegeben werden sollen.

TypeInfoResolver

Ruft den von dieser Instanz verwendeten JsonTypeInfo Vertragslöser ab oder legt diesen fest.

TypeInfoResolverChain

Ruft die Liste der verketteten JsonTypeInfo Von dieser Instanz verwendeten Vertragslöser ab.

UnknownTypeHandling

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie der als Object deklarierte Typ während der Deserialisierung behandelt wird.

UnmappedMemberHandling

Dient zum Abrufen oder Festlegen eines Objekts, das angibt, wie JsonSerializer JSON-Eigenschaften behandelt, die keinem bestimmten .NET-Element zugeordnet werden können, wenn Objekttypen deserialisieren.

Web

Ruft eine schreibgeschützte Singletoninstanz von JsonSerializerOptions ab, die die Webkonfiguration verwendet.

WriteIndented

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob JSON hübsches Drucken verwenden soll. Standardmäßig wird JSON ohne zusätzlichen Leerraum serialisiert.

Methoden

AddContext<TContext>()
Veraltet.

Fügt eine neue JsonSerializerContext an die Metadatenauflösung der aktuellen JsonSerializerOptions Instanz an.

Equals(Object)

Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht.

(Geerbt von Object)
GetConverter(Type)

Gibt den Konverter für den angegebenen Typ zurück.

GetHashCode()

Dient als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft die Type der aktuellen Instanz ab.

(Geerbt von Object)
GetTypeInfo(Type)

Ruft die JsonTypeInfo Vertragsmetadaten ab, die von der aktuellen JsonSerializerOptions Instanz aufgelöst wurden.

MakeReadOnly()

Kennzeichnet die aktuelle Instanz als schreibgeschützt, um weitere Benutzeränderungen zu verhindern.

MakeReadOnly(Boolean)

Markiert die aktuelle Instanz als schreibgeschützt, hindert sie an weiteren Benutzeränderungen.

MemberwiseClone()

Erstellt eine flache Kopie der aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)
TryGetTypeInfo(Type, JsonTypeInfo)

Versucht, die JsonTypeInfo Vertragsmetadaten abzurufen, die von der aktuellen JsonSerializerOptions Instanz aufgelöst wurden.

Erweiterungsmethoden

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Ruft das JSON-Schema für type als JsonNode Dokument ab.

Gilt für: