Compartir a través de


JsonSerializerOptions Clase

Definición

Proporciona opciones que se usarán con JsonSerializer.

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

Comentarios

Para obtener más información, consulte Cómo serializar y deserializar JSON.

Constructores

JsonSerializerOptions()

Inicializa una nueva instancia de la clase JsonSerializerOptions.

JsonSerializerOptions(JsonSerializerDefaults)

Construye una nueva instancia de JsonSerializerOptions con un conjunto predefinido de opciones determinado por el JsonSerializerDefaultsespecificado.

JsonSerializerOptions(JsonSerializerOptions)

Copia las opciones de una instancia de JsonSerializerOptions en una nueva instancia.

Propiedades

AllowOutOfOrderMetadataProperties

Permite especificar propiedades de metadatos JSON después de las propiedades normales en un objeto JSON deserializado.

AllowTrailingCommas

Obtiene o establece un valor que indica si se permite (y omite) una coma adicional al final de una lista de valores JSON en un objeto o matriz dentro de la carga JSON que se deserializa.

Converters

Obtiene la lista de convertidores definidos por el usuario que se registraron.

Default

Obtiene una instancia de singleton de solo lectura de JsonSerializerOptions que usa la configuración predeterminada.

DefaultBufferSize

Obtiene o establece el tamaño de búfer predeterminado, en bytes, que se usará al crear búferes temporales.

DefaultIgnoreCondition

Obtiene o establece un valor que determina cuándo se omiten las propiedades con valores predeterminados durante la serialización o deserialización. El valor predeterminado es Never.

DictionaryKeyPolicy

Obtiene o establece la directiva que se usa para convertir el nombre de una clave de IDictionary a otro formato, como el uso de mayúsculas y minúsculas de camel.

Encoder

Obtiene o establece el codificador que se va a usar al escapar cadenas o null usar el codificador predeterminado.

IgnoreNullValues
Obsoletos.

Obtiene o establece un valor que indica si null valores se omiten durante la serialización y deserialización. El valor predeterminado es false.

IgnoreReadOnlyFields

Obtiene o establece un valor que indica si los campos de solo lectura se omiten durante la serialización. Un campo es de solo lectura si está marcado con la palabra clave readonly. El valor predeterminado es false.

IgnoreReadOnlyProperties

Obtiene un valor que indica si se omiten las propiedades de solo lectura durante la serialización. El valor predeterminado es false.

IncludeFields

Obtiene o establece un valor que indica si los campos se controlan durante la serialización y deserialización. El valor predeterminado es false.

IndentCharacter

Define el carácter de sangría que se usa cuando WriteIndented está habilitado. El valor predeterminado es el carácter de espacio.

IndentSize

Define el tamaño de sangría que se usa cuando se habilita WriteIndented. El valor predeterminado es dos.

IsReadOnly

Obtiene un valor que indica si la instancia actual se ha bloqueado para la modificación del usuario.

MaxDepth

Obtiene o establece la profundidad máxima permitida al serializar o deserializar JSON, con el valor predeterminado de 0 que indica una profundidad máxima de 64.

NewLine

Obtiene o establece la nueva cadena de línea que se va a usar cuando WriteIndented es true.

El valor predeterminado es NewLine.

NumberHandling

Obtiene o establece un objeto que especifica cómo se deben controlar los tipos de número al serializar o deserializar.

PreferredObjectCreationHandling

Obtiene o establece el control de creación de objetos preferido para las propiedades al deserializar JSON.

PropertyNameCaseInsensitive

Obtiene o establece un valor que indica si el nombre de una propiedad usa una comparación sin distinción entre mayúsculas y minúsculas durante la deserialización. El valor predeterminado es false.

PropertyNamingPolicy

Obtiene o establece un valor que especifica la directiva que se usa para convertir el nombre de una propiedad en un objeto a otro formato, como mayúsculas y minúsculas, o null dejar los nombres de propiedad sin cambios.

ReadCommentHandling

Obtiene o establece un valor que define cómo se controlan los comentarios durante la deserialización.

ReferenceHandler

Obtiene o establece un objeto que especifica cómo se controlan las referencias de objeto al leer y escribir JSON.

RespectNullableAnnotations

Obtiene o establece un valor que indica si se deben respetar las anotaciones de nulabilidad durante la serialización y deserialización.

RespectRequiredConstructorParameters

Obtiene o establece un valor que indica si se deben especificar parámetros de constructor no opcionales durante la deserialización.

TypeInfoResolver

Obtiene o establece el solucionador de contratos JsonTypeInfo usado por esta instancia.

TypeInfoResolverChain

Obtiene la lista de solucionadores de contratos de JsonTypeInfo encadenados usados por esta instancia.

UnknownTypeHandling

Obtiene o establece un objeto que especifica cómo se controla la deserialización de un tipo declarado como un Object durante la deserialización.

UnmappedMemberHandling

Obtiene o establece un objeto que especifica cómo JsonSerializer controla las propiedades JSON que no se pueden asignar a un miembro de .NET específico al deserializar tipos de objeto.

Web

Obtiene una instancia singleton de solo lectura de JsonSerializerOptions que usa la configuración web.

WriteIndented

Obtiene o establece un valor que indica si JSON debe usar una impresión bonita. De forma predeterminada, JSON se serializa sin ningún espacio en blanco adicional.

Métodos

AddContext<TContext>()
Obsoletos.

Anexa un nuevo JsonSerializerContext a la resolución de metadatos de la instancia de JsonSerializerOptions actual.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.

(Heredado de Object)
GetConverter(Type)

Devuelve el convertidor para el tipo especificado.

GetHashCode()

Actúa como función hash predeterminada.

(Heredado de Object)
GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
GetTypeInfo(Type)

Obtiene los metadatos del contrato JsonTypeInfo resueltos por la instancia de JsonSerializerOptions actual.

MakeReadOnly()

Marca la instancia actual como de solo lectura para evitar cualquier modificación adicional del usuario.

MakeReadOnly(Boolean)

Marca la instancia actual como de solo lectura, lo que impide cualquier modificación adicional del usuario.

MemberwiseClone()

Crea una copia superficial del Objectactual.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)
TryGetTypeInfo(Type, JsonTypeInfo)

Intenta obtener los metadatos del contrato JsonTypeInfo resueltos por la instancia de JsonSerializerOptions actual.

Métodos de extensión

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Obtiene el esquema JSON de type como un documento de JsonNode.

Se aplica a