JsonSerializerOptions Klasa

Definicja

Udostępnia opcje do użycia z JsonSerializer.

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

Uwagi

Aby uzyskać więcej informacji, zobacz Jak serializować i deserializowaćJSON.

Konstruktory

JsonSerializerOptions()

Inicjuje nowe wystąpienie klasy JsonSerializerOptions.

JsonSerializerOptions(JsonSerializerDefaults)

Tworzy nowe wystąpienie JsonSerializerOptions ze wstępnie zdefiniowanym zestawem opcji określonych JsonSerializerDefaults.

JsonSerializerOptions(JsonSerializerOptions)

Kopiuje opcje z wystąpienia JsonSerializerOptions do nowego wystąpienia.

Właściwości

AllowOutOfOrderMetadataProperties

Umożliwia określenie właściwości metadanych JSON po regularnych właściwościach w zdeserializowanym obiekcie JSON.

AllowTrailingCommas

Pobierz lub ustawia wartość wskazującą, czy dodatkowy przecinek na końcu listy wartości JSON w obiekcie lub tablicy jest dozwolony (i ignorowany) w ładunku JSON jest deserializowany.

Converters

Pobiera listę zarejestrowanych konwerterów zdefiniowanych przez użytkownika.

Default

Pobiera pojedyncze wystąpienie JsonSerializerOptions tylko do odczytu, które używa konfiguracji domyślnej.

DefaultBufferSize

Pobiera lub ustawia domyślny rozmiar buforu w bajtach do użycia podczas tworzenia tymczasowych.

DefaultIgnoreCondition

Pobiera lub ustawia wartość, która określa, kiedy właściwości z wartościami domyślnymi są ignorowane podczas serializacji lub deserializacji. Wartość domyślna to Never.

DictionaryKeyPolicy

Pobiera lub ustawia zasady używane do konwertowania nazwy klucza IDictionary na inny format, taki jak camel-casing.

Encoder

Pobiera lub ustawia koder do użycia podczas ucieczki ciągów lub null do używania kodera domyślnego.

IgnoreNullValues
Przestarzałe.

Pobiera lub ustawia wartość wskazującą, czy null wartości są ignorowane podczas serializacji i deserializacji. Wartość domyślna to false.

IgnoreReadOnlyFields

Pobiera lub ustawia wartość wskazującą, czy pola tylko do odczytu są ignorowane podczas serializacji. Pole jest tylko do odczytu, jeśli jest oznaczone słowem kluczowym readonly. Wartość domyślna to false.

IgnoreReadOnlyProperties

Pobiera wartość wskazującą, czy właściwości tylko do odczytu są ignorowane podczas serializacji. Wartość domyślna to false.

IncludeFields

Pobiera lub ustawia wartość wskazującą, czy pola są obsługiwane podczas serializacji i deserializacji. Wartość domyślna to false.

IndentCharacter

Definiuje znak wcięcia używany podczas włączania WriteIndented. Domyślnie jest to znak spacji.

IndentSize

Definiuje rozmiar wcięcia używany podczas włączania WriteIndented. Wartość domyślna to dwa.

IsReadOnly

Pobiera wartość wskazującą, czy bieżące wystąpienie zostało zablokowane w celu modyfikacji użytkownika.

MaxDepth

Pobiera lub ustawia maksymalną głębokość dozwoloną podczas serializacji lub deserializacji danych JSON z wartością domyślną 0 wskazującą maksymalną głębokość 64.

NewLine

Pobiera lub ustawia nowy ciąg wiersza do użycia, gdy WriteIndented jest true.

Wartość domyślna to wartość NewLine.

NumberHandling

Pobiera lub ustawia obiekt określający sposób obsługi typów liczb podczas serializacji lub deserializacji.

PreferredObjectCreationHandling

Pobiera lub ustawia preferowaną obsługę tworzenia obiektów dla właściwości podczas deserializacji kodu JSON.

PropertyNameCaseInsensitive

Pobiera lub ustawia wartość wskazującą, czy nazwa właściwości używa porównania bez uwzględniania wielkości liter podczas deserializacji. Wartość domyślna to false.

PropertyNamingPolicy

Pobiera lub ustawia wartość określającą zasady używane do konwertowania nazwy właściwości na obiekt do innego formatu, takiego jak casl-casing, lub null pozostawić nazwy właściwości bez zmian.

ReadCommentHandling

Pobiera lub ustawia wartość, która definiuje sposób obsługi komentarzy podczas deserializacji.

ReferenceHandler

Pobiera lub ustawia obiekt określający sposób obsługi odwołań do obiektów podczas odczytywania i zapisywania kodu JSON.

RespectNullableAnnotations

Pobiera lub ustawia wartość wskazującą, czy adnotacje o wartości null powinny być przestrzegane podczas serializacji i deserializacji.

RespectRequiredConstructorParameters

Pobiera lub ustawia wartość wskazującą, czy podczas deserializacji należy określić parametry konstruktora nie opcjonalnego.

TypeInfoResolver

Pobiera lub ustawia program rozpoznawania kontraktów JsonTypeInfo używany przez to wystąpienie.

TypeInfoResolverChain

Pobiera listę łańcuchowych JsonTypeInfo rozpoznawania kontraktów używanych przez to wystąpienie.

UnknownTypeHandling

Pobiera lub ustawia obiekt określający sposób deserializacji typu zadeklarowanego jako Object jest obsługiwany podczas deserializacji.

UnmappedMemberHandling

Pobiera lub ustawia obiekt określający sposób, w jaki JsonSerializer obsługuje właściwości JSON, których nie można zamapować do określonego elementu członkowskiego platformy .NET podczas deserializacji typów obiektów.

Web

Pobiera jednotonowe wystąpienie JsonSerializerOptions tylko do odczytu, które korzysta z konfiguracji sieci Web.

WriteIndented

Pobiera lub ustawia wartość wskazującą, czy kod JSON powinien używać dość drukowania. Domyślnie kod JSON jest serializowany bez dodatkowego odstępu.

Metody

AddContext<TContext>()
Przestarzałe.

Dołącza nowy JsonSerializerContext do rozpoznawania metadanych bieżącego wystąpienia JsonSerializerOptions.

Equals(Object)

Określa, czy określony obiekt jest równy bieżącemu obiektowi.

(Odziedziczone po Object)
GetConverter(Type)

Zwraca konwerter dla określonego typu.

GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżącego wystąpienia.

(Odziedziczone po Object)
GetTypeInfo(Type)

Pobiera metadane kontraktu JsonTypeInfo rozpoznawane przez bieżące wystąpienie JsonSerializerOptions.

MakeReadOnly()

Oznacza bieżące wystąpienie jako tylko do odczytu, aby zapobiec dalszej modyfikacji użytkownika.

MakeReadOnly(Boolean)

Oznacza bieżące wystąpienie jako tylko do odczytu, co uniemożliwia dalsze modyfikacje użytkownika.

MemberwiseClone()

Tworzy płytkią kopię bieżącego Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)
TryGetTypeInfo(Type, JsonTypeInfo)

Próbuje uzyskać metadane kontraktu JsonTypeInfo rozpoznane przez bieżące wystąpienie JsonSerializerOptions.

Metody rozszerzania

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Pobiera schemat JSON dla type jako dokument JsonNode.

Dotyczy