JavaScriptConverter.Serialize Method (Object, JavaScriptSerializer)

 

When overridden in a derived class, builds a dictionary of name/value pairs.

Namespace:   System.Web.Script.Serialization
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

public abstract IDictionary<string, object> Serialize(
	object obj,
	JavaScriptSerializer serializer
)

Parameters

obj
Type: System.Object

The object to serialize.

serializer
Type: System.Web.Script.Serialization.JavaScriptSerializer

The object that is responsible for the serialization.

Return Value

Type: System.Collections.Generic.IDictionary<String, Object>

An object that contains key/value pairs that represent the object’s data.

When you serialize a type for which a custom converter is registered, the JavaScriptSerializer instance invokes the Serialize method.

Notes to Inheritors:

The return value of Serialize must be an IDictionary<TKey, TValue> instance with zero or more name/value pairs that represent an object’s data to be converted to JSON. The converter itself does not serialize data as JSON. Instead, the converter builds a dictionary of name/value pairs that contain the property names (the string key for the dictionary) and corresponding property values (the object value in the dictionary). The JavaScriptSerializer instance subsequently converts these to JSON.

If the converter encounters an exception, it should throw an InvalidOperationException error that describes the problem.

.NET Framework
Available since 3.5
Return to top
Show: