JsonSerializerOptions Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Poskytuje možnosti pro 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
| Name | Description |
|---|---|
| JsonSerializerOptions() |
Inicializuje novou instanci JsonSerializerOptions třídy. |
| JsonSerializerOptions(JsonSerializerDefaults) |
Vytvoří novou JsonSerializerOptions instanci s předdefinovanou sadou možností určených zadaným JsonSerializerDefaults. |
| JsonSerializerOptions(JsonSerializerOptions) |
Zkopíruje možnosti z JsonSerializerOptions instance do nové instance. |
Vlastnosti
| Name | Description |
|---|---|
| AllowDuplicateProperties |
Získá nebo nastaví hodnotu, která určuje, zda jsou při deserializaci objektů JSON povoleny duplicitní názvy vlastností. |
| AllowOutOfOrderMetadataProperties |
Získá nebo nastaví hodnotu, která označuje, zda vlastnosti metadat JSON lze zadat 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á jedinou 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 IDictionary názvu klíče do jiného formátu, například camel-casing. |
| Encoder |
Získá nebo nastaví kodér, který se má použít při escaping string, nebo |
| IgnoreNullValues |
Zastaralé.
Získá nebo nastaví hodnotu, která určuje, zda |
| 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 |
| IgnoreReadOnlyProperties |
Získá nebo nastaví hodnotu, která označuje, zda jsou vlastnosti jen pro čtení ignorovány během serializace. Výchozí hodnota je |
| IncludeFields |
Získá nebo nastaví hodnotu, která určuje, zda pole jsou zpracována během serializace a deserializace.
Výchozí hodnota je |
| IndentCharacter |
Definuje znak odsazení, který se používá při WriteIndented povolení. Výchozí hodnota je znak mezery. |
| IndentSize |
Definuje velikost odsazení, která se používá, když WriteIndented je povolená. 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, pokud WriteIndented je 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 |
| 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 |
| 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. |
| Strict |
Získá jen pro čtení jednoúčelovou JsonSerializerOptions instanci, která používá striktní konfiguraci. |
| TypeInfoResolver |
Získá nebo nastaví překladač kontraktu JsonTypeInfo 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í .NET člen při deserializaci typů objektů. |
| Web |
Získá jednoúčelovou instanci JsonSerializerOptions jen pro čtení, která používá webovou konfiguraci. |
| 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
| Name | Description |
|---|---|
| AddContext<TContext>() |
Zastaralé.
Připojí novou JsonSerializerContext k rozlišení metadat aktuální JsonSerializerOptions instance. |
| 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) |
JsonTypeInfo Získá metadata kontraktu vyřešena aktuální JsonSerializerOptions instancí. |
| GetTypeInfo<T>() |
Poskytuje možnosti pro použití s JsonSerializer. |
| 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í JsonSerializerOptions instancí. |
| TryGetTypeInfo<T>(JsonTypeInfo<T>) |
Poskytuje možnosti pro použití s JsonSerializer. |
Metody rozšíření
| Name | Description |
|---|---|
| AddAIContentType(JsonSerializerOptions, Type, String) |
Přidá vlastní typ obsahu do polymorfní konfigurace pro AIContent. |
| AddAIContentType<TContent>(JsonSerializerOptions, String) |
Přidá vlastní typ obsahu do polymorfní konfigurace pro AIContent. |
| GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions) |
Vygeneruje schéma JSON odpovídající metadatům kontraktu zadaného typu. |