Class JsonSerializerSettings

Specifies the settings on a JsonSerializer object.

Inheritance

System.Object

JsonSerializerSettings

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Bayat.Json

Assembly: Bayat.Json.Runtime.dll

Syntax

public class JsonSerializerSettings

Constructors

JsonSerializerSettings()

Initializes a new instance of the JsonSerializerSettings class.

Declaration

public JsonSerializerSettings()

Fields

_checkAdditionalContent

Declaration

protected bool? _checkAdditionalContent

Field Value

Type	Description
System.Nullable<System.Boolean>

_constructorHandling

Declaration

protected ConstructorHandling? _constructorHandling

Field Value

Type	Description
System.Nullable<ConstructorHandling>

_context

Declaration

protected StreamingContext? _context

Field Value

Type	Description
System.Nullable<System.Runtime.Serialization.StreamingContext>

_culture

Declaration

protected CultureInfo _culture

Field Value

Type	Description
System.Globalization.CultureInfo

_dateFormatHandling

Declaration

protected DateFormatHandling? _dateFormatHandling

Field Value

Type	Description
System.Nullable<DateFormatHandling>

_dateFormatString

Declaration

protected string _dateFormatString

Field Value

Type	Description
System.String

_dateFormatStringSet

Declaration

protected bool _dateFormatStringSet

Field Value

Type	Description
System.Boolean

_dateParseHandling

Declaration

protected DateParseHandling? _dateParseHandling

Field Value

Type	Description
System.Nullable<DateParseHandling>

_dateTimeZoneHandling

Declaration

protected DateTimeZoneHandling? _dateTimeZoneHandling

Field Value

Type	Description
System.Nullable<DateTimeZoneHandling>

_defaultValueHandling

Declaration

protected DefaultValueHandling? _defaultValueHandling

Field Value

Type	Description
System.Nullable<DefaultValueHandling>

_floatFormatHandling

Declaration

protected FloatFormatHandling? _floatFormatHandling

Field Value

Type	Description
System.Nullable<FloatFormatHandling>

_floatParseHandling

Declaration

protected FloatParseHandling? _floatParseHandling

Field Value

Type	Description
System.Nullable<FloatParseHandling>

_formatting

Declaration

protected Formatting? _formatting

Field Value

Type	Description
System.Nullable<Formatting>

_maxDepth

Declaration

protected int? _maxDepth

Field Value

Type	Description
System.Nullable<System.Int32>

_maxDepthSet

Declaration

protected bool _maxDepthSet

Field Value

Type	Description
System.Boolean

_metadataPropertyHandling

Declaration

protected MetadataPropertyHandling? _metadataPropertyHandling

Field Value

Type	Description
System.Nullable<MetadataPropertyHandling>

_missingMemberHandling

Declaration

protected MissingMemberHandling? _missingMemberHandling

Field Value

Type	Description
System.Nullable<MissingMemberHandling>

_nullValueHandling

Declaration

protected NullValueHandling? _nullValueHandling

Field Value

Type	Description
System.Nullable<NullValueHandling>

_objectCreationHandling

Declaration

protected ObjectCreationHandling? _objectCreationHandling

Field Value

Type	Description
System.Nullable<ObjectCreationHandling>

_preserveReferencesHandling

Declaration

protected PreserveReferencesHandling? _preserveReferencesHandling

Field Value

Type	Description
System.Nullable<PreserveReferencesHandling>

_referenceLoopHandling

Declaration

protected ReferenceLoopHandling? _referenceLoopHandling

Field Value

Type	Description
System.Nullable<ReferenceLoopHandling>

_serializeScriptableObjects

Declaration

protected bool? _serializeScriptableObjects

Field Value

Type	Description
System.Nullable<System.Boolean>

_stringEscapeHandling

Declaration

protected StringEscapeHandling? _stringEscapeHandling

Field Value

Type	Description
System.Nullable<StringEscapeHandling>

_typeNameAssemblyFormat

Declaration

protected FormatterAssemblyStyle? _typeNameAssemblyFormat

Field Value

Type	Description
System.Nullable<System.Runtime.Serialization.Formatters.FormatterAssemblyStyle>

_typeNameHandling

Declaration

protected TypeNameHandling? _typeNameHandling

Field Value

Type	Description
System.Nullable<TypeNameHandling>

DefaultCheckAdditionalContent

Declaration

public const bool DefaultCheckAdditionalContent = false

Field Value

Type	Description
System.Boolean

DefaultConstructorHandling

Declaration

public const ConstructorHandling DefaultConstructorHandling = ConstructorHandling.Default

Field Value

Type	Description
ConstructorHandling

DefaultContext

Declaration

public static readonly StreamingContext DefaultContext

Field Value

Type	Description
System.Runtime.Serialization.StreamingContext

DefaultCulture

Declaration

public static readonly CultureInfo DefaultCulture

Field Value

Type	Description
System.Globalization.CultureInfo

DefaultDateFormatHandling

Declaration

public const DateFormatHandling DefaultDateFormatHandling = DateFormatHandling.IsoDateFormat

Field Value

Type	Description
DateFormatHandling

DefaultDateFormatString

Declaration

public const string DefaultDateFormatString = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK"

Field Value

Type	Description
System.String

DefaultDateParseHandling

Declaration

public const DateParseHandling DefaultDateParseHandling = DateParseHandling.DateTime

Field Value

Type	Description
DateParseHandling

DefaultDateTimeZoneHandling

Declaration

public const DateTimeZoneHandling DefaultDateTimeZoneHandling = DateTimeZoneHandling.RoundtripKind

Field Value

Type	Description
DateTimeZoneHandling

DefaultDefaultValueHandling

Declaration

public const DefaultValueHandling DefaultDefaultValueHandling = DefaultValueHandling.Include

Field Value

Type	Description
DefaultValueHandling

DefaultFloatFormatHandling

Declaration

public const FloatFormatHandling DefaultFloatFormatHandling = FloatFormatHandling.String

Field Value

Type	Description
FloatFormatHandling

DefaultFloatParseHandling

Declaration

public const FloatParseHandling DefaultFloatParseHandling = FloatParseHandling.Double

Field Value

Type	Description
FloatParseHandling

DefaultFormatterAssemblyStyle

Declaration

public const FormatterAssemblyStyle DefaultFormatterAssemblyStyle = FormatterAssemblyStyle.Simple

Field Value

Type	Description
System.Runtime.Serialization.Formatters.FormatterAssemblyStyle

DefaultFormatting

Declaration

public const Formatting DefaultFormatting = Formatting.None

Field Value

Type	Description
Formatting

DefaultMetadataPropertyHandling

Declaration

public const MetadataPropertyHandling DefaultMetadataPropertyHandling = MetadataPropertyHandling.Default

Field Value

Type	Description
MetadataPropertyHandling

DefaultMissingMemberHandling

Declaration

public const MissingMemberHandling DefaultMissingMemberHandling = MissingMemberHandling.Ignore

Field Value

Type	Description
MissingMemberHandling

DefaultNullValueHandling

Declaration

public const NullValueHandling DefaultNullValueHandling = NullValueHandling.Include

Field Value

Type	Description
NullValueHandling

DefaultObjectCreationHandling

Declaration

public const ObjectCreationHandling DefaultObjectCreationHandling = ObjectCreationHandling.Auto

Field Value

Type	Description
ObjectCreationHandling

DefaultPreserveReferencesHandling

Declaration

public const PreserveReferencesHandling DefaultPreserveReferencesHandling = PreserveReferencesHandling.None

Field Value

Type	Description
PreserveReferencesHandling

DefaultReferenceLoopHandling

Declaration

public const ReferenceLoopHandling DefaultReferenceLoopHandling = ReferenceLoopHandling.Error

Field Value

Type	Description
ReferenceLoopHandling

DefaultSerializeScriptableObjects

Declaration

public const bool DefaultSerializeScriptableObjects = false

Field Value

Type	Description
System.Boolean

DefaultStringEscapeHandling

Declaration

public const StringEscapeHandling DefaultStringEscapeHandling = StringEscapeHandling.Default

Field Value

Type	Description
StringEscapeHandling

DefaultTypeNameAssemblyFormat

Declaration

public const FormatterAssemblyStyle DefaultTypeNameAssemblyFormat = FormatterAssemblyStyle.Simple

Field Value

Type	Description
System.Runtime.Serialization.Formatters.FormatterAssemblyStyle

DefaultTypeNameHandling

Declaration

public const TypeNameHandling DefaultTypeNameHandling = TypeNameHandling.None

Field Value

Type	Description
TypeNameHandling

Properties

Binder

Gets or sets the System.Runtime.Serialization.SerializationBinder used by the serializer when resolving type names.

Declaration

public SerializationBinder Binder { get; set; }

Property Value

Type	Description
System.Runtime.Serialization.SerializationBinder	The binder.

CheckAdditionalContent

Gets a value indicating whether there will be a check for additional content after deserializing an object.

Declaration

public bool CheckAdditionalContent { get; set; }

Property Value

Type	Description
System.Boolean	true if there will be a check for additional content after deserializing an object; otherwise, false.

ConstructorHandling

Gets or sets how constructors are used during deserialization.

Declaration

public ConstructorHandling ConstructorHandling { get; set; }

Property Value

Type	Description
ConstructorHandling	The constructor handling.

Context

Gets or sets the System.Runtime.Serialization.StreamingContext used by the serializer when invoking serialization callback methods.

Declaration

public StreamingContext Context { get; set; }

Property Value

Type	Description
System.Runtime.Serialization.StreamingContext	The context.

ContractResolver

Gets or sets the contract resolver used by the serializer when serializing .NET objects to JSON and vice versa.

Declaration

public IContractResolver ContractResolver { get; set; }

Property Value

Type	Description
IContractResolver	The contract resolver.

Converters

Gets or sets a JsonConverter collection that will be used during serialization.

Declaration

public IList<JsonConverter> Converters { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<JsonConverter>	The converters.

Culture

Gets or sets the culture used when reading JSON. Defaults to System.Globalization.CultureInfo.InvariantCulture.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo

DateFormatHandling

Get or set how dates are written to JSON text.

Declaration

public DateFormatHandling DateFormatHandling { get; set; }

Property Value

Type	Description
DateFormatHandling

DateFormatString

Get or set how System.DateTime and System.DateTimeOffset values are formatted when writing JSON text, and the expected date format when reading JSON text.

Declaration

public string DateFormatString { get; set; }

Property Value

Type	Description
System.String

DateParseHandling

Get or set how date formatted strings, e.g. "/Date(1198908717056)/" and "2012-03-21T05:40Z", are parsed when reading JSON.

Declaration

public DateParseHandling DateParseHandling { get; set; }

Property Value

Type	Description
DateParseHandling

DateTimeZoneHandling

Get or set how System.DateTime time zones are handling during serialization and deserialization.

Declaration

public DateTimeZoneHandling DateTimeZoneHandling { get; set; }

Property Value

Type	Description
DateTimeZoneHandling

DefaultValueHandling

Gets or sets how null default are handled during serialization and deserialization.

Declaration

public DefaultValueHandling DefaultValueHandling { get; set; }

Property Value

Type	Description
DefaultValueHandling	The default value handling.

EqualityComparer

Gets or sets the equality comparer used by the serializer when comparing references.

Declaration

public IEqualityComparer EqualityComparer { get; set; }

Property Value

Type	Description
System.Collections.IEqualityComparer	The equality comparer.

Error

Gets or sets the error handler called during serialization and deserialization.

Declaration

public EventHandler<ErrorEventArgs> Error { get; set; }

Property Value

Type	Description
System.EventHandler<ErrorEventArgs>	The error handler called during serialization and deserialization.

FloatFormatHandling

Get or set how special floating point numbers, e.g. System.Double.NaN, System.Double.PositiveInfinity and System.Double.NegativeInfinity, are written as JSON.

Declaration

public FloatFormatHandling FloatFormatHandling { get; set; }

Property Value

Type	Description
FloatFormatHandling

FloatParseHandling

Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.

Declaration

public FloatParseHandling FloatParseHandling { get; set; }

Property Value

Type	Description
FloatParseHandling

Formatting

Indicates how JSON text output is formatted.

Declaration

public Formatting Formatting { get; set; }

Property Value

Type	Description
Formatting

MaxDepth

Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a JsonReaderException.

Declaration

public int? MaxDepth { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MetadataPropertyHandling

Gets or sets how metadata properties are used during deserialization.

Declaration

public MetadataPropertyHandling MetadataPropertyHandling { get; set; }

Property Value

Type	Description
MetadataPropertyHandling	The metadata properties handling.

MissingMemberHandling

Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization.

Declaration

public MissingMemberHandling MissingMemberHandling { get; set; }

Property Value

Type	Description
MissingMemberHandling	Missing member handling.

NullValueHandling

Gets or sets how null values are handled during serialization and deserialization.

Declaration

public NullValueHandling NullValueHandling { get; set; }

Property Value

Type	Description
NullValueHandling	Null value handling.

ObjectCreationHandling

Gets or sets how objects are created during deserialization.

Declaration

public ObjectCreationHandling ObjectCreationHandling { get; set; }

Property Value

Type	Description
ObjectCreationHandling	The object creation handling.

PreserveReferencesHandling

Gets or sets how object references are preserved by the serializer.

Declaration

public PreserveReferencesHandling PreserveReferencesHandling { get; set; }

Property Value

Type	Description
PreserveReferencesHandling	The preserve references handling.

ReferenceLoopHandling

Gets or sets how reference loops (e.g. a class referencing itself) is handled.

Declaration

public ReferenceLoopHandling ReferenceLoopHandling { get; set; }

Property Value

Type	Description
ReferenceLoopHandling	Reference loop handling.

ReferenceResolver

Gets or sets the IReferenceResolver used by the serializer when resolving references.

Declaration

[Obsolete("ReferenceResolver property is obsolete. Use the ReferenceResolverProvider property to set the IReferenceResolver: settings.ReferenceResolverProvider = () => resolver")]
public IReferenceResolver ReferenceResolver { get; set; }

Property Value

Type	Description
IReferenceResolver	The reference resolver.

ReferenceResolverProvider

Gets or sets a function that creates the IReferenceResolver used by the serializer when resolving references.

Declaration

public Func<IReferenceResolver> ReferenceResolverProvider { get; set; }

Property Value

Type	Description
System.Func<IReferenceResolver>	A function that creates the IReferenceResolver used by the serializer when resolving references.

SerializeScriptableObjects

Gets a value indicating whether to serialize ScriptableObjects data or not.

Declaration

public bool SerializeScriptableObjects { get; set; }

Property Value

Type	Description
System.Boolean

StringEscapeHandling

Get or set how strings are escaped when writing JSON text.

Declaration

public StringEscapeHandling StringEscapeHandling { get; set; }

Property Value

Type	Description
StringEscapeHandling

TraceWriter

Gets or sets the ITraceWriter used by the serializer when writing trace messages.

Declaration

public ITraceWriter TraceWriter { get; set; }

Property Value

Type	Description
ITraceWriter	The trace writer.

TypeNameAssemblyFormat

Gets or sets how a type name assembly is written and resolved by the serializer.

Declaration

public FormatterAssemblyStyle TypeNameAssemblyFormat { get; set; }

Property Value

Type	Description
System.Runtime.Serialization.Formatters.FormatterAssemblyStyle	The type name assembly format.

TypeNameHandling

Gets or sets how type name writing and reading is handled by the serializer.

Declaration

public TypeNameHandling TypeNameHandling { get; set; }

Property Value

Type	Description
TypeNameHandling	The type name handling.

Remarks

TypeNameHandling should be used with caution when your application deserializes JSON from an external source. Incoming types should be validated with a custom System.Runtime.Serialization.SerializationBinder when deserializing with a value other than TypeNameHandling.None.