 | JsonSerializer Class |
Serializes and deserializes objects into and from the JSON format.
The JsonSerializer enables you to control how objects are encoded into JSON.
Inheritance HierarchyNamespace: Newtonsoft.Json
Assembly: Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db
SyntaxC#
public class JsonSerializer
The JsonSerializer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | JsonSerializer |
Initializes a new instance of the JsonSerializer class.
|
Properties| Name | Description | |
|---|---|---|
 | Binder | Obsolete.
Gets or sets the SerializationBinder used by the serializer when resolving type names.
|
| CheckAdditionalContent |
Gets a value indicating whether there will be a check for additional JSON content after deserializing an object.
The default value is false.
|
| ConstructorHandling |
Gets or sets how constructors are used during deserialization.
The default value is Default.
|
| Context |
Gets or sets the StreamingContext used by the serializer when invoking serialization callback methods.
|
| ContractResolver |
Gets or sets the contract resolver used by the serializer when
serializing .NET objects to JSON and vice versa.
|
| Converters |
Gets a collection JsonConverter that will be used during serialization.
|
| Culture |
Gets or sets the culture used when reading JSON.
The default value is InvariantCulture.
|
| DateFormatHandling |
Gets or sets how dates are written to JSON text.
The default value is IsoDateFormat.
|
| DateFormatString |
Gets or sets how DateTime and DateTimeOffset values are formatted when writing JSON text,
and the expected date format when reading JSON text.
The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK".
|
| DateParseHandling |
Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON.
The default value is DateTime.
|
| DateTimeZoneHandling |
Gets or sets how DateTime time zones are handled during serialization and deserialization.
The default value is RoundtripKind.
|
| DefaultValueHandling |
Gets or sets how default values are handled during serialization and deserialization.
The default value is Include.
|
| EqualityComparer |
Gets or sets the equality comparer used by the serializer when comparing references.
|
| FloatFormatHandling |
Gets or sets how special floating point numbers, e.g. NaN,
PositiveInfinity and NegativeInfinity,
are written as JSON text.
The default value is String.
|
| FloatParseHandling |
Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
The default value is Double.
|
| Formatting |
Indicates how JSON text output is formatted.
The default value is None.
|
| MaxDepth |
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a JsonReaderException.
A null value means there is no maximum.
The default value is null.
|
| MetadataPropertyHandling |
Gets or sets how metadata properties are used during deserialization.
The default value is Default.
|
| 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.
The default value is Ignore.
|
| NullValueHandling |
Gets or sets how null values are handled during serialization and deserialization.
The default value is Include.
|
| ObjectCreationHandling |
Gets or sets how objects are created during deserialization.
The default value is Auto.
|
| PreserveReferencesHandling |
Gets or sets how object references are preserved by the serializer.
The default value is None.
|
| ReferenceLoopHandling |
Gets or sets how reference loops (e.g. a class referencing itself) is handled.
The default value is Error.
|
| ReferenceResolver |
Gets or sets the IReferenceResolver used by the serializer when resolving references.
|
| SerializationBinder |
Gets or sets the ISerializationBinder used by the serializer when resolving type names.
|
| StringEscapeHandling |
Gets or sets how strings are escaped when writing JSON text.
The default value is Default.
|
| TraceWriter |
Gets or sets the ITraceWriter used by the serializer when writing trace messages.
|
| TypeNameAssemblyFormat | Obsolete.
Gets or sets how a type name assembly is written and resolved by the serializer.
The default value is Simple.
|
| TypeNameAssemblyFormatHandling |
Gets or sets how a type name assembly is written and resolved by the serializer.
The default value is Simple.
|
| TypeNameHandling |
Gets or sets how type name writing and reading is handled by the serializer.
The default value is None.
|
Methods| Name | Description | |
|---|---|---|
 | Create |
Creates a new JsonSerializer instance.
The JsonSerializer will not use default settings
from DefaultSettings.
|
| Create(JsonSerializerSettings) |
Creates a new JsonSerializer instance using the specified JsonSerializerSettings.
The JsonSerializer will not use default settings
from DefaultSettings.
|
| CreateDefault |
Creates a new JsonSerializer instance.
The JsonSerializer will use default settings
from DefaultSettings.
|
| CreateDefault(JsonSerializerSettings) |
Creates a new JsonSerializer instance using the specified JsonSerializerSettings.
The JsonSerializer will use default settings
from DefaultSettings as well as the specified JsonSerializerSettings.
|
| Deserialize(JsonReader) |
Deserializes the JSON structure contained by the specified JsonReader.
|
| Deserialize(TextReader, Type) |
Deserializes the JSON structure contained by the specified StringReader
into an instance of the specified type.
|
| Deserialize(JsonReader, Type) |
Deserializes the JSON structure contained by the specified JsonReader
into an instance of the specified type.
|
| DeserializeT(JsonReader) |
Deserializes the JSON structure contained by the specified JsonReader
into an instance of the specified type.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Populate(TextReader, Object) |
Populates the JSON values onto the target object.
|
| Populate(JsonReader, Object) |
Populates the JSON values onto the target object.
|
| Serialize(TextWriter, Object) |
Serializes the specified Object and writes the JSON structure
using the specified TextWriter.
|
| Serialize(JsonWriter, Object) |
Serializes the specified Object and writes the JSON structure
using the specified JsonWriter.
|
| Serialize(TextWriter, Object, Type) |
Serializes the specified Object and writes the JSON structure
using the specified TextWriter.
|
| Serialize(JsonWriter, Object, Type) |
Serializes the specified Object and writes the JSON structure
using the specified JsonWriter.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Error |
Occurs when the JsonSerializer errors during serialization and deserialization.
|
See Also