DataContractJsonSerializer Class

Reference

Definition

Namespace:: System.Runtime.Serialization.Json

Assembly:: System.Runtime.Serialization.Json.dll

Assembly:: System.ServiceModel.Web.dll

Assembly:: System.Runtime.Serialization.dll

Assembly:: netstandard.dll

Source:: DataContractJsonSerializer.cs

Source:: DataContractJsonSerializer.cs

Source:: DataContractJsonSerializer.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Serializes objects to the JavaScript Object Notation (JSON) and deserializes JSON data to objects. This class cannot be inherited.

public ref class DataContractJsonSerializer sealed

public ref class DataContractJsonSerializer sealed : System::Runtime::Serialization::XmlObjectSerializer

public sealed class DataContractJsonSerializer

public sealed class DataContractJsonSerializer : System.Runtime.Serialization.XmlObjectSerializer

type DataContractJsonSerializer = class

type DataContractJsonSerializer = class
    inherit XmlObjectSerializer

Public NotInheritable Class DataContractJsonSerializer

Public NotInheritable Class DataContractJsonSerializer
Inherits XmlObjectSerializer

Inheritance: Object
DataContractJsonSerializer

Inheritance: Object

XmlObjectSerializer
DataContractJsonSerializer

Remarks

For most scenarios that involve serializing to JSON and deserializing from JSON, we recommend the APIs in the System.Text.Json namespace.

If your scenario requires the DataContractJsonSerializer class, you can use it to serialize instances of a type into a JSON document and to deserialize a JSON document into an instance of a type. For example, you can create a type named Person with properties that contain essential data, such as a name and address. You can then create and manipulate an instance of the Person class and write all of its property values in a JSON document for later retrieval. This JSON document can later be deserialized into the Person class or another class with an equivalent data contract.

If an error occurs during the serialization of an outgoing reply on the server or the reply operation throws an exception for some other reason, it may not get returned to the client as a fault.

Constructors

DataContractJsonSerializer(Type)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type.
DataContractJsonSerializer(Type, DataContractJsonSerializerSettings)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type and serializer settings.
DataContractJsonSerializer(Type, IEnumerable<Type>)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type, with a collection of known types that may be present in the object graph.
DataContractJsonSerializer(Type, IEnumerable<Type>, Int32, Boolean, IDataContractSurrogate, Boolean)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type. This method also specifies a list of known types that may be present in the object graph, the maximum number of graph items to serialize or deserialize, whether to ignore unexpected data or emit type information, and a surrogate for custom serialization.
DataContractJsonSerializer(Type, String)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of a specified type using the XML root element specified by a parameter.
DataContractJsonSerializer(Type, String, IEnumerable<Type>)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of a specified type using the XML root element specified by a parameter, with a collection of known types that may be present in the object graph.
DataContractJsonSerializer(Type, String, IEnumerable<Type>, Int32, Boolean, IDataContractSurrogate, Boolean)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type. This method also specifies the root name of the XML element, a list of known types that may be present in the object graph, the maximum number of graph items to serialize or deserialize, whether to ignore unexpected data or emit type information, and a surrogate for custom serialization.
DataContractJsonSerializer(Type, XmlDictionaryString)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of a specified type using the XML root element specified by a parameter of type XmlDictionaryString.
DataContractJsonSerializer(Type, XmlDictionaryString, IEnumerable<Type>)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of a specified type using the XML root element specified by a parameter of type XmlDictionaryString, with a collection of known types that may be present in the object graph.
DataContractJsonSerializer(Type, XmlDictionaryString, IEnumerable<Type>, Int32, Boolean, IDataContractSurrogate, Boolean)	Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type. This method also specifies the root name of the XML element, a list of known types that may be present in the object graph, the maximum number of graph items to serialize or deserialize, whether to ignore unexpected data or emit type information, and a surrogate for custom serialization.

Properties

DataContractSurrogate	Gets a surrogate type that is currently active for a given IDataContractSurrogate instance. Surrogates can extend the serialization or deserialization process.
DateTimeFormat	Gets the format of the date and time type items in object graph.
EmitTypeInformation	Gets or sets the data contract JSON serializer settings to emit type information.
IgnoreExtensionDataObject	Gets a value that specifies whether unknown data is ignored on deserialization and whether the IExtensibleDataObject interface is ignored on serialization.
KnownTypes	Gets a collection of types that may be present in the object graph serialized using this instance of the DataContractJsonSerializer.
MaxItemsInObjectGraph	Gets the maximum number of items in an object graph that the serializer serializes or deserializes in one read or write call.
SerializeReadOnlyTypes	Gets or sets a value that specifies whether to serialize read only types.
UseSimpleDictionaryFormat	Gets a value that specifies whether to use a simple dictionary format.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetSerializationSurrogateProvider()
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsStartObject(XmlDictionaryReader)	Gets a value that specifies whether the XmlDictionaryReader is positioned over an XML element that represents an object the serializer can deserialize from.
IsStartObject(XmlReader)	Determines whether the XmlReader is positioned on an object that can be deserialized.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ReadObject(Stream)	Reads a document stream in the JSON (JavaScript Object Notation) format and returns the deserialized object.
ReadObject(XmlDictionaryReader)	Reads the XML document mapped from JSON (JavaScript Object Notation) with an XmlDictionaryReader and returns the deserialized object.
ReadObject(XmlDictionaryReader, Boolean)	Reads the XML document mapped from JSON with an XmlDictionaryReader and returns the deserialized object; it also enables you to specify whether the serializer should verify that it is positioned on an appropriate element before attempting to deserialize.
ReadObject(XmlReader)	Reads the XML document mapped from JSON (JavaScript Object Notation) with an XmlReader and returns the deserialized object.
ReadObject(XmlReader, Boolean)	Reads an XML document mapped from JSON with an XmlReader and returns the deserialized object; it also enables you to specify whether the serializer should verify that it is positioned on an appropriate element before attempting to deserialize.
SetSerializationSurrogateProvider(ISerializationSurrogateProvider)
ToString()	Returns a string that represents the current object. (Inherited from Object)
WriteEndObject(XmlDictionaryWriter)	Writes the closing XML element to an XML document, using an XmlDictionaryWriter, which can be mapped to JavaScript Object Notation (JSON).
WriteEndObject(XmlWriter)	Writes the closing XML element to an XML document, using an XmlWriter, which can be mapped to JavaScript Object Notation (JSON).
WriteObject(Stream, Object)	Serializes a specified object to JavaScript Object Notation (JSON) data and writes the resulting JSON to a stream.
WriteObject(XmlDictionaryWriter, Object)	Serializes an object to XML that may be mapped to JavaScript Object Notation (JSON). Writes all the object data, including the starting XML element, content, and closing element, with an XmlDictionaryWriter.
WriteObject(XmlWriter, Object)	Serializes an object to XML that may be mapped to JavaScript Object Notation (JSON). Writes all the object data, including the starting XML element, content, and closing element, with an XmlWriter.
WriteObjectContent(XmlDictionaryWriter, Object)	Writes the XML content that can be mapped to JavaScript Object Notation (JSON) using an XmlDictionaryWriter.
WriteObjectContent(XmlWriter, Object)	Writes the XML content that can be mapped to JavaScript Object Notation (JSON) using an XmlWriter.
WriteStartObject(XmlDictionaryWriter, Object)	Writes the opening XML element for serializing an object to XML that can be mapped to JavaScript Object Notation (JSON) using an XmlDictionaryWriter.
WriteStartObject(XmlWriter, Object)	Writes the opening XML element for serializing an object to XML that can be mapped to JavaScript Object Notation (JSON) using an XmlWriter.

Applies to

Share via