JsonObject JsonObject JsonObject JsonObject Class

Initializes a new instance of a JsonObject that represents a JSON object containing a collection of name and JsonValue pairs.

public : JsonObject()public JsonObject()Public Sub New()// This API is not available in Javascript.

Gets or sets the element with the specified key.

This member is not implemented in C++TValue this[TKey key] { get; set; }Property Item(key As TKey) As TValueTValue this[TKey key] { get; set; }

Gets an System.Collections.Generic.ICollection`1 containing the keys of the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++ICollection<TKey> Keys { get; }ReadOnly Property Keys As ICollection(Of TKey)ICollection<TKey> Keys { get; }

Gets the size (count) of the collection.

public : unsigned int Size { get; }This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Gets an System.Collections.Generic.ICollection`1 containing the values in the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++ICollection<TValue> Values { get; }ReadOnly Property Values As ICollection(Of TValue)ICollection<TValue> Values { get; }

Gets the type of the encapsulated JSON value. Possible types are defined by JsonValueType.

public : JsonValueType ValueType { get; }public JsonValueType ValueType { get; }Public ReadOnly Property ValueType As JsonValueType// This API is not available in Javascript.

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++void Add(TKey key, TValue value)Sub Add(key As TKey, value As TValue)void Add(TKey key, TValue value)

Removes all items from the collection.

public : void Clear()This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Determines whether the System.Collections.Generic.IDictionary`2 contains an element with the specified key.

This member is not implemented in C++bool ContainsKey(TKey key)Function ContainsKey(key As TKey) As Booleanbool ContainsKey(TKey key)

Returns the iterator for iteration over the key/value pairs in the JsonObject.

public : IIterator<IKeyValuePair<PlatForm::String, IJsonValue>> First()This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Returns a JsonArray if the ValueType of the encapsulated value is Array.

public : JsonArray GetArray()public JsonArray GetArray()Public Function GetArray() As JsonArray// This API is not available in Javascript.

Gets a Boolean if the ValueType of the encapsulated value is Boolean.

public : PlatForm::Boolean GetBoolean()public bool GetBoolean()Public Function GetBoolean() As bool// This API is not available in Javascript.

Returns an enumerator that iterates through the collection.

This member is not implemented in C++IEnumerator<T> GetEnumerator()Function GetEnumerator As IEnumerator(Of T)IEnumerator<T> GetEnumerator()

Gets the JsonArray value with the specified name.

public : JsonArray GetNamedArray(PlatForm::String name)public JsonArray GetNamedArray(String name)Public Function GetNamedArray(name As String) As JsonArray// This API is not available in Javascript.

Remarks

This method should always used with a try/catch block because it throws an exception if the name found is not a JsonArray type or the name is not found.

See Also

GetNamedArray(String, JsonArray)GetNamedArray(String, JsonArray)GetNamedArray(String, JsonArray)GetNamedArray(String, JsonArray)

Gets the JsonArray value with the specified name, or the provided default value if no such named value is found.

public : JsonArray GetNamedArray(PlatForm::String name, JsonArray defaultValue)public JsonArray GetNamedArray(String name, JsonArray defaultValue)Public Function GetNamedArray(name As String, defaultValue As JsonArray) As JsonArray// This API is not available in Javascript.

See Also

GetNamedArray(String)GetNamedArray(String)GetNamedArray(String)GetNamedArray(String)

Gets the Boolean value with the specified name.

public : PlatForm::Boolean GetNamedBoolean(PlatForm::String name)public bool GetNamedBoolean(String name)Public Function GetNamedBoolean(name As String) As bool// This API is not available in Javascript.

Remarks

This method should always used with a try/catch block because it throws an exception if the name found is not a Boolean type or the name is not found.

See Also

GetNamedBoolean(String, Boolean)GetNamedBoolean(String, Boolean)GetNamedBoolean(String, Boolean)GetNamedBoolean(String, Boolean)

Gets the Boolean value with the specified name, or the provided default value if no such named value is found.

public : PlatForm::Boolean GetNamedBoolean(PlatForm::String name, bool defaultValue)public bool GetNamedBoolean(String name, Boolean defaultValue)Public Function GetNamedBoolean(name As String, defaultValue As Boolean) As bool// This API is not available in Javascript.

See Also

GetNamedBoolean(String)GetNamedBoolean(String)GetNamedBoolean(String)GetNamedBoolean(String)

Gets the number value (a Double) with the specified name.

public : double GetNamedNumber(PlatForm::String name)public double GetNamedNumber(String name)Public Function GetNamedNumber(name As String) As double// This API is not available in Javascript.

Remarks

This method should always used with a try/catch block because it throws an exception if the name found is not a Double type or the name is not found.

See Also

GetNamedNumber(String, Double)GetNamedNumber(String, Double)GetNamedNumber(String, Double)GetNamedNumber(String, Double)

Gets the number value (a Double) with the specified name, or the provided default value if no such named value is found.

public : double GetNamedNumber(PlatForm::String name, double defaultValue)public double GetNamedNumber(String name, Double defaultValue)Public Function GetNamedNumber(name As String, defaultValue As Double) As double// This API is not available in Javascript.

See Also

GetNamedNumber(String)GetNamedNumber(String)GetNamedNumber(String)GetNamedNumber(String)

Gets the JsonObject value with the specified name.

public : JsonObject GetNamedObject(PlatForm::String name)public JsonObject GetNamedObject(String name)Public Function GetNamedObject(name As String) As JsonObject// This API is not available in Javascript.

Remarks

This method should always used with a try/catch block because it throws an exception if the name found is not a JsonObject type or the name is not found.

See Also

GetNamedObject(String, JsonObject)GetNamedObject(String, JsonObject)GetNamedObject(String, JsonObject)GetNamedObject(String, JsonObject)

Gets the JsonObject value with the specified name, or the provided default value if no such named value is found.

public : JsonObject GetNamedObject(PlatForm::String name, JsonObject defaultValue)public JsonObject GetNamedObject(String name, JsonObject defaultValue)Public Function GetNamedObject(name As String, defaultValue As JsonObject) As JsonObject// This API is not available in Javascript.

See Also

GetNamedObject(String)GetNamedObject(String)GetNamedObject(String)GetNamedObject(String)

Gets the String value with the specified name.

public : PlatForm::String GetNamedString(PlatForm::String name)public string GetNamedString(String name)Public Function GetNamedString(name As String) As string// This API is not available in Javascript.

Remarks

This method should always used with a try/catch block because it throws an exception if the name found is not a String type or the name is not found.

See Also

GetNamedString(String, String)GetNamedString(String, String)GetNamedString(String, String)GetNamedString(String, String)

Gets the String value with the specified name, or the provided default value if no such named value is found.

public : PlatForm::String GetNamedString(PlatForm::String name, PlatForm::String defaultValue)public string GetNamedString(String name, String defaultValue)Public Function GetNamedString(name As String, defaultValue As String) As string// This API is not available in Javascript.

See Also

GetNamedString(String)GetNamedString(String)GetNamedString(String)GetNamedString(String)

Gets the JsonValue value with the specified name.

public : JsonValue GetNamedValue(PlatForm::String name)public JsonValue GetNamedValue(String name)Public Function GetNamedValue(name As String) As JsonValue// This API is not available in Javascript.

Remarks

This method should always used with a try/catch block because it throws an exception if the name found is not a JsonValue type or the name is not found.

See Also

GetNamedValue(String, JsonValue)GetNamedValue(String, JsonValue)GetNamedValue(String, JsonValue)GetNamedValue(String, JsonValue)

Gets the specified JsonValue value, or the provided default value if no such named value is found.

public : JsonValue GetNamedValue(PlatForm::String name, JsonValue defaultValue)public JsonValue GetNamedValue(String name, JsonValue defaultValue)Public Function GetNamedValue(name As String, defaultValue As JsonValue) As JsonValue// This API is not available in Javascript.

See Also

GetNamedValue(String)GetNamedValue(String)GetNamedValue(String)GetNamedValue(String)

Gets the number (a Double) if the ValueType of the encapsulated value is Number.

public : double GetNumber()public double GetNumber()Public Function GetNumber() As double// This API is not available in Javascript.

Gets the JsonObject if the ValueType of the encapsulated value is Object.

public : JsonObject GetObject()public JsonObject GetObject()Public Function GetObject() As JsonObject// This API is not available in Javascript.

Gets the String if the ValueType of the encapsulated value is String.

public : PlatForm::String GetString()public string GetString()Public Function GetString() As string// This API is not available in Javascript.

Gets a JsonObject view.

public : IMapView<PlatForm::String, IJsonValue> GetView()This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Indicates whether the JsonObject has an entry with the requested key.

public : PlatForm::Boolean HasKey(PlatForm::String key)This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Adds a new entry to the JsonObject.

public : PlatForm::Boolean Insert(PlatForm::String key, IJsonValue value)This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Gets the JSON value associated with the supplied key, if an entry with that key exists.

public : IJsonValue Lookup(PlatForm::String key)This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Parses the specified JSON string that represents a JsonObject into a JSON value.

public : static JsonObject Parse(PlatForm::String input)public static JsonObject Parse(String input)Public Static Function Parse(input As String) As JsonObject// This API is not available in Javascript.

Remarks

This method may only be called when the ValueType is Null. If the value contained in the specified JSON string is a String, a Number or a Boolean, the ValueType will be updated and the actual value can then be accessed through the GetString, GetNumber or GetBoolean methods. If Parse fails due to an invalid JSON string or resource allocation errors, the ValueType will not be changed.

When implemented on the subclass JsonObject, this method requires the specified input string to be a valid JSON object value. When implemented on the subclass JsonArray, this method requires the specified input string to be a valid JSON array value. The original object state will be overwritten when JsonObject.@Windows.Data.Json.JsonValue.Parse(System.String)?text=Parse or JsonArray.@Windows.Data.Json.JsonValue.Parse(System.String)?text=Parse succeeds. If Parse fails, the object state remains intact.

See Also

TryParse(String, JsonObject)TryParse(String, JsonObject)TryParse(String, JsonObject)TryParse(String, JsonObject)

Removes the element with the specified key from the System.Collections.Generic.IDictionary`2.

This member is not implemented in C++bool Remove(TKey key)Function Remove(key As TKey) As Booleanbool Remove(TKey key)

Removes a specific item from the JsonObject.

public : void Remove(PlatForm::String key)This member is not implemented in C#This member is not implemented in VB.Net// This API is not available in Javascript.

Sets the value of the first JsonValue object with the specified name to the specified value. If no such object is found, a new name and JsonValue pair is inserted into the JSON object.

public : void SetNamedValue(PlatForm::String name, IJsonValue value)public void SetNamedValue(String name, IJsonValue value)Public Function SetNamedValue(name As String, value As IJsonValue) As void// This API is not available in Javascript.

Retrieves the JSON representation of the encapsulated value.

public : PlatForm::String Stringify()public string Stringify()Public Function Stringify() As string// This API is not available in Javascript.

Remarks

If the ValueType is String, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format.

Retrieves the JSON representation of the encapsulated value.

public : PlatForm::String ToString()public string ToString()Public Function ToString() As string// This API is not available in Javascript.

Remarks

If the ValueType is String, then the returned string will be properly escaped and double quoted. This method is used for serializing the encapsulated value into a valid JSON format.

Gets the value associated with the specified key.

This member is not implemented in C++bool TryGetValue(TKey key, out TValue value)Function TryGetValue(key As TKey, ByRef value As TValue) As Booleanbool TryGetValue(TKey key, out TValue value)

Parses the specified string that represents a JSON object into a JsonObject.

public : static PlatForm::Boolean TryParse(PlatForm::String input, JsonObject result)public static bool TryParse(String input, JsonObject result)Public Static Function TryParse(input As String, result As JsonObject) As bool// This API is not available in Javascript.