DataContractJsonSerializer Class

DataContractJsonSerializer Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

System.Object
  System.Runtime.Serialization.Json.DataContractJsonSerializer

Namespace:  System.Runtime.Serialization.Json
Assembly:  System.ServiceModel.Web (in System.ServiceModel.Web.dll)

public sealed class DataContractJsonSerializer

The DataContractJsonSerializer type exposes the following members.

  NameDescription
Public methodDataContractJsonSerializer(Type)Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type.
Public methodDataContractJsonSerializer(Type, IEnumerable<Type>)Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of a specified type with a collection of known types that may be present in the object graph.
Public methodDataContractJsonSerializer(Type, DataContractJsonSerializerSettings)Initializes a new instance of the DataContractJsonSerializer class to serialize or deserialize an object of the specified type and serializer settings.
Top

  NameDescription
Public propertyDateTimeFormatGets the format of the date and time type items in object graph.
Public propertyEmitTypeInformationGets or sets the data contract JSON serializer settings to emit type information.
Public propertyKnownTypesGets a collection of types that may be present in the object graph serialized using this instance of the DataContractJsonSerializer.
Public propertySerializeReadOnlyTypesGets or sets a value that specifies whether to serialize read only types.
Public propertyUseSimpleDictionaryFormatGets or sets a value that specifies whether to use a simple dictionary format.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadObjectReads a document stream in the JSON (JavaScript Object Notation) format and returns the deserialized object.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteObjectSerializes a specified object to JavaScript Object Notation (JSON) data and writes the resulting JSON to a stream.
Top

Use the DataContractJsonSerializer class 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.


namespace SL_DataContractJsonSerializer
{
    public partial class Page : PhoneApplicationPage
    {
        public Page()
        {
            InitializeComponent();
        }

        //This uses an event handler, not SL data binding
        void OnClick(object sender, EventArgs args)
        {
            txtOutput1.Text = "Create a User object and serialize it.";
            string json = WriteFromObject();
            txtOutput2.Text = json.ToString(); // Displays: {"Age":42,"Name":"Bob"}

            txtOutput3.Text = "Deserialize the data to a User object.";
            string jsonString = "{'Name':'Bill', 'Age':53}";
            User deserializedUser = ReadToObject(jsonString);
            txtOutput4.Text = deserializedUser.Name; // Displays: Bill
            txtOutput5.Text = deserializedUser.Age.ToString(); // Displays: 53
        }
        // Create a User object and serialize it to a JSON stream.
        public static string WriteFromObject()
        {
            //Create User object.
            User user = new User("Bob", 42);

            //Create a stream to serialize the object to.
            MemoryStream ms = new MemoryStream();

            // Serializer the User object to the stream.
            DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(User));
            ser.WriteObject(ms, user);
            byte[] json = ms.ToArray();
            ms.Close();
            return Encoding.UTF8.GetString(json, 0, json.Length);

        }

        // Deserialize a JSON stream to a User object.
        public static User ReadToObject(string json)
        {
            User deserializedUser = new User();
            MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(json));
            DataContractJsonSerializer ser = new DataContractJsonSerializer(deserializedUser.GetType());
            deserializedUser = ser.ReadObject(ms) as User;
            ms.Close();
            return deserializedUser;
        }

    }

    [DataContract]
    public class User
    {
        [DataMember]
        public string Name { get; set; }

        [DataMember]
        public int Age { get; set; }

        public User() { }

        public User(string newName, int newAge)
        {
            Name = newName;
            Age = newAge;
        }

    }

}



Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2017 Microsoft