JsonSerializerOptions Třída

Definice

Poskytuje možnosti použití s JsonSerializer.

public ref class JsonSerializerOptions sealed
public sealed class JsonSerializerOptions
type JsonSerializerOptions = class
Public NotInheritable Class JsonSerializerOptions
Dědičnost
JsonSerializerOptions

Poznámky

Další informace naleznete v tématu Jak serializovat a deserializovat JSON.

Konstruktory

JsonSerializerOptions()

Inicializuje novou instanci JsonSerializerOptions třídy.

JsonSerializerOptions(JsonSerializerDefaults)

Vytvoří novou instanci JsonSerializerOptions s předdefinovanou sadou možností určených zadaným JsonSerializerDefaults.

JsonSerializerOptions(JsonSerializerOptions)

Zkopíruje možnosti z instance JsonSerializerOptions do nové instance.

Vlastnosti

AllowOutOfOrderMetadataProperties

Umožňuje zadat vlastnosti metadat JSON po běžných vlastnostech v deserializovaném objektu JSON.

AllowTrailingCommas

Získá nebo nastaví hodnotu, která označuje, jestli je na konci seznamu hodnot JSON v objektu nebo poli povolená (a ignorována) v datové části JSON, která se deserializuje.

Converters

Získá seznam uživatelem definovaných převaděčů, které byly zaregistrovány.

Default

Získá jednoúčelovou instanci JsonSerializerOptions jen pro čtení, která používá výchozí konfiguraci.

DefaultBufferSize

Získá nebo nastaví výchozí velikost vyrovnávací paměti v bajtech použít při vytváření dočasných vyrovnávacích pamětí.

DefaultIgnoreCondition

Získá nebo nastaví hodnotu, která určuje, kdy vlastnosti s výchozími hodnotami jsou ignorovány během serializace nebo deserializace. Výchozí hodnota je Never.

DictionaryKeyPolicy

Získá nebo nastaví zásadu použitou k převodu názvu klíče IDictionary do jiného formátu, například camel-casing.

Encoder

Získá nebo nastaví kodér, který se má použít při escaping strings, nebo null použít výchozí kodér.

IgnoreNullValues
Zastaralé.

Získá nebo nastaví hodnotu, která určuje, zda null hodnoty jsou ignorovány během serializace a deserializace. Výchozí hodnota je false.

IgnoreReadOnlyFields

Získá nebo nastaví hodnotu, která označuje, zda pole jen pro čtení jsou ignorována během serializace. Pole je jen pro čtení, pokud je označené klíčovým slovem readonly. Výchozí hodnota je false.

IgnoreReadOnlyProperties

Získá hodnotu, která určuje, zda jsou vlastnosti jen pro čtení ignorovány během serializace. Výchozí hodnota je false.

IncludeFields

Získá nebo nastaví hodnotu, která určuje, zda pole jsou zpracována během serializace a deserializace. Výchozí hodnota je false.

IndentCharacter

Definuje znak odsazení, který se používá při povolení WriteIndented. Výchozí hodnota je znak mezery.

IndentSize

Definuje velikost odsazení, která se používá při povolení WriteIndented. Výchozí hodnota je dvě.

IsReadOnly

Získá hodnotu, která označuje, zda aktuální instance byla uzamčena pro úpravy uživatele.

MaxDepth

Získá nebo nastaví maximální povolenou hloubku při serializaci nebo deserializaci JSON s výchozí hodnotou 0 označující maximální hloubku 64.

NewLine

Získá nebo nastaví nový řádek řetězec použít při WriteIndented je true.

Výchozí hodnota je hodnota NewLine.

NumberHandling

Získá nebo nastaví objekt, který určuje, jak číselné typy mají být zpracovány při serializaci nebo deserializaci.

PreferredObjectCreationHandling

Získá nebo nastaví upřednostňované zpracování vytváření objektů pro vlastnosti při deserializaci JSON.

PropertyNameCaseInsensitive

Získá nebo nastaví hodnotu, která určuje, zda název vlastnosti používá porovnání nerozlišující malá a velká písmena během deserializace. Výchozí hodnota je false.

PropertyNamingPolicy

Získá nebo nastaví hodnotu, která určuje zásadu použitou k převodu názvu vlastnosti na objektu do jiného formátu, například camel-casing, nebo null ponechat názvy vlastností beze změny.

ReadCommentHandling

Získá nebo nastaví hodnotu, která definuje, jak se komentáře zpracovávají během deserializace.

ReferenceHandler

Získá nebo nastaví objekt, který určuje způsob zpracování odkazů na objekt při čtení a zápisu JSON.

RespectNullableAnnotations

Získá nebo nastaví hodnotu, která označuje, zda mají být poznámky nullability dodrženy během serializace a deserializace.

RespectRequiredConstructorParameters

Získá nebo nastaví hodnotu, která indikuje, zda parametry konstruktoru nejsou volitelné být zadány během deserializace.

TypeInfoResolver

Získá nebo nastaví JsonTypeInfo překladač kontraktu používaný touto instancí.

TypeInfoResolverChain

Získá seznam zřetězených JsonTypeInfo překladačů kontraktů používaných touto instancí.

UnknownTypeHandling

Získá nebo nastaví objekt, který určuje, jak deserializace typu deklarovaný jako Object je zpracována během deserializace.

UnmappedMemberHandling

Získá nebo nastaví objekt, který určuje, jak JsonSerializer zpracovává vlastnosti JSON, které nelze mapovat na konkrétního člena .NET při deserializaci typů objektů.

Web

Získá jednoúčelovou instanci jen pro čtení JsonSerializerOptions, která používá konfiguraci webu.

WriteIndented

Získá nebo nastaví hodnotu, která označuje, jestli má JSON používat pěkný tisk. Ve výchozím nastavení se JSON serializuje bez nadbytečného prázdného místa.

Metody

AddContext<TContext>()
Zastaralé.

Připojí nový JsonSerializerContext k rozlišení metadat aktuální instance JsonSerializerOptions.

Equals(Object)

Určuje, zda je zadaný objekt roven aktuálnímu objektu.

(Zděděno od Object)
GetConverter(Type)

Vrátí převaděč pro zadaný typ.

GetHashCode()

Slouží jako výchozí funkce hash.

(Zděděno od Object)
GetType()

Získá Type aktuální instance.

(Zděděno od Object)
GetTypeInfo(Type)

Získá metadata kontraktu JsonTypeInfo vyřešena aktuální JsonSerializerOptions instance.

MakeReadOnly()

Označí aktuální instanci jako jen pro čtení, aby se zabránilo jakékoli další úpravě uživatele.

MakeReadOnly(Boolean)

Označí aktuální instanci jako jen pro čtení, aby se zabránilo jakékoli další úpravě uživatele.

MemberwiseClone()

Vytvoří mělkou kopii aktuálního Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)
TryGetTypeInfo(Type, JsonTypeInfo)

Pokusí se získat metadata kontraktu JsonTypeInfo vyřešená aktuální instancí JsonSerializerOptions.

Metody rozšíření

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Získá schéma JSON pro type jako dokument JsonNode.

Platí pro