JsonSerializerOptions Klass
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Innehåller alternativ som ska användas med JsonSerializer.
public ref class JsonSerializerOptions sealed
public sealed class JsonSerializerOptions
type JsonSerializerOptions = class
Public NotInheritable Class JsonSerializerOptions
- Arv
-
JsonSerializerOptions
Kommentarer
Mer information finns i Serialisera och deserialisera JSON.
Konstruktorer
| Name | Description |
|---|---|
| JsonSerializerOptions() |
Initierar en ny instans av JsonSerializerOptions klassen. |
| JsonSerializerOptions(JsonSerializerDefaults) |
Konstruerar en ny JsonSerializerOptions instans med en fördefinierad uppsättning alternativ som bestäms av den angivna JsonSerializerDefaults. |
| JsonSerializerOptions(JsonSerializerOptions) |
Kopierar alternativen från en JsonSerializerOptions instans till en ny instans. |
Egenskaper
| Name | Description |
|---|---|
| AllowDuplicateProperties |
Hämtar eller anger ett värde som anger om dubbletter av egenskapsnamn tillåts när JSON-objekt deserialiseras. |
| AllowOutOfOrderMetadataProperties |
Hämtar eller anger ett värde som anger om JSON-metadataegenskaper kan anges efter vanliga egenskaper i ett deserialiserat JSON-objekt. |
| AllowTrailingCommas |
Hämta eller anger ett värde som anger om ett extra kommatecken i slutet av en lista med JSON-värden i ett objekt eller en matris tillåts (och ignoreras) i JSON-nyttolasten som deserialiseras. |
| Converters |
Hämtar listan över användardefinierade konverterare som har registrerats. |
| Default |
Hämtar en skrivskyddad singleton-instans av JsonSerializerOptions som använder standardkonfigurationen. |
| DefaultBufferSize |
Hämtar eller anger standardbuffertstorleken i byte som ska användas när tillfälliga buffertar skapas. |
| DefaultIgnoreCondition |
Hämtar eller anger ett värde som avgör när egenskaper med standardvärden ignoreras under serialisering eller deserialisering. Standardvärdet är Never. |
| DictionaryKeyPolicy |
Hämtar eller anger principen som används för att konvertera en IDictionary nyckels namn till ett annat format, till exempel kamelhölje. |
| Encoder |
Hämtar eller ställer in kodaren som ska användas när du tar bort strängar, eller |
| IgnoreNullValues |
Föråldrad.
Hämtar eller anger ett värde som anger om |
| IgnoreReadOnlyFields |
Hämtar eller anger ett värde som anger om skrivskyddade fält ignoreras under serialiseringen. Ett fält är skrivskyddat om det är markerat med nyckelordet |
| IgnoreReadOnlyProperties |
Hämtar eller anger ett värde som anger om skrivskyddade egenskaper ignoreras under serialiseringen. Standardvärdet är |
| IncludeFields |
Hämtar eller anger ett värde som anger om fält hanteras under serialisering och deserialisering.
Standardvärdet är |
| IndentCharacter |
Definierar indragstecknet som används när WriteIndented är aktiverat. Standardvärdet är blankstegstecknet. |
| IndentSize |
Definierar indragsstorleken som används när WriteIndented är aktiverad. Standardvärdet är två. |
| IsReadOnly |
Hämtar ett värde som anger om den aktuella instansen har låsts för användarändring. |
| MaxDepth |
Hämtar eller anger det maximala djup som tillåts vid serialisering eller deserialisering av JSON, med standardvärdet 0 som anger ett maximalt djup på 64. |
| NewLine |
Hämtar eller anger den nya radsträngen som ska användas när WriteIndented är Standardvärdet är NewLine. |
| NumberHandling |
Hämtar eller anger ett objekt som anger hur nummertyper ska hanteras vid serialisering eller deserialisering. |
| PreferredObjectCreationHandling |
Hämtar eller anger önskad hantering av objektskapande för egenskaper vid deserialisering av JSON. |
| PropertyNameCaseInsensitive |
Hämtar eller anger ett värde som anger om en egenskaps namn använder en skiftlägeskänslig jämförelse under deserialiseringen. Standardvärdet är |
| PropertyNamingPolicy |
Hämtar eller anger ett värde som anger principen som används för att konvertera en egenskaps namn på ett objekt till ett annat format, till exempel kamelhölje, eller |
| ReadCommentHandling |
Hämtar eller anger ett värde som definierar hur kommentarer hanteras under deserialisering. |
| ReferenceHandler |
Hämtar eller anger ett objekt som anger hur objektreferenser ska hanteras vid läsning och skrivning av JSON. |
| RespectNullableAnnotations |
Hämtar eller anger ett värde som anger om nullabilitetsanteckningar ska respekteras under serialisering och deserialisering. |
| RespectRequiredConstructorParameters |
Hämtar eller anger ett värde som anger om icke-valfria konstruktorparametrar ska anges under deserialiseringen. |
| Strict |
Hämtar en skrivskyddad singleton-instans av JsonSerializerOptions som använder den strikta konfigurationen. |
| TypeInfoResolver |
Hämtar eller anger den JsonTypeInfo kontraktslösare som används av den här instansen. |
| TypeInfoResolverChain |
Hämtar listan över länkade JsonTypeInfo kontraktslösare som används av den här instansen. |
| UnknownTypeHandling |
Hämtar eller anger ett objekt som anger hur deserialisering av en typ som deklarerats som en Object hanteras under deserialiseringen. |
| UnmappedMemberHandling |
Hämtar eller anger ett objekt som anger hur JsonSerializer hanterar JSON-egenskaper som inte kan mappas till en specifik .NET medlem vid deserialisering av objekttyper. |
| Web |
Hämtar en skrivskyddad singleton-instans av JsonSerializerOptions som använder webbkonfigurationen. |
| WriteIndented |
Hämtar eller anger ett värde som anger om JSON ska använda snygga utskrifter. Som standard serialiseras JSON utan extra tomt utrymme. |
Metoder
| Name | Description |
|---|---|
| AddContext<TContext>() |
Föråldrad.
Lägger till en ny JsonSerializerContext i metadataupplösningen för den aktuella JsonSerializerOptions instansen. |
| Equals(Object) |
Avgör om det angivna objektet är lika med det aktuella objektet. (Ärvd från Object) |
| GetConverter(Type) |
Returnerar konverteraren för den angivna typen. |
| GetHashCode() |
Fungerar som standard-hash-funktion. (Ärvd från Object) |
| GetType() |
Hämtar den aktuella instansen Type . (Ärvd från Object) |
| GetTypeInfo(Type) |
Hämtar kontraktmetadata JsonTypeInfo som matchas av den aktuella JsonSerializerOptions instansen. |
| GetTypeInfo<T>() |
Innehåller alternativ som ska användas med JsonSerializer. |
| MakeReadOnly() |
Markerar den aktuella instansen som skrivskyddad för att förhindra ytterligare användarändringar. |
| MakeReadOnly(Boolean) |
Markerar den aktuella instansen som skrivskyddad och förhindrar ytterligare användarändringar. |
| MemberwiseClone() |
Skapar en ytlig kopia av den aktuella Object. (Ärvd från Object) |
| ToString() |
Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Object) |
| TryGetTypeInfo(Type, JsonTypeInfo) |
Försöker få kontraktmetadata JsonTypeInfo lösta av den aktuella JsonSerializerOptions instansen. |
| TryGetTypeInfo<T>(JsonTypeInfo<T>) |
Innehåller alternativ som ska användas med JsonSerializer. |
Tilläggsmetoder
| Name | Description |
|---|---|
| AddAIContentType(JsonSerializerOptions, Type, String) |
Lägger till en anpassad innehållstyp i den polymorfa konfigurationen för AIContent. |
| AddAIContentType<TContent>(JsonSerializerOptions, String) |
Lägger till en anpassad innehållstyp i den polymorfa konfigurationen för AIContent. |
| GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions) |
Genererar ett JSON-schema som motsvarar kontraktmetadata för den angivna typen. |