JsonObject C# Reference Documentation

JsonObject

Current Version: 9.5.0.75

Represents a JSON object, which contains an unordered set of name/value pairs. Each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

Chilkat.JsonObject obj = new Chilkat.JsonObject();

Properties

DebugLogFilePath
public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DelimiterChar
public string DelimiterChar {get; set; }
Introduced in version 9.5.0.58

Sets the delimiter char for JSON paths. The default value is ".". To use Firebase style paths, set this property to "/". (This is a string property that should have a length of 1 char.)

top
EmitCompact
public bool EmitCompact {get; set; }
Introduced in version 9.5.0.56

If true then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If false, then emits with whitespace and indentation to make the JSON human-readable.

The default value is true.

top
EmitCrLf
public bool EmitCrLf {get; set; }
Introduced in version 9.5.0.56

If true then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If false, then bare-LF's are emitted. (The compact format emits to a single line with no end-of-line characters.) Windows systems traditionally use CRLF line-endings, whereas Linux, Mac OS X, and other systems traditionally use bare-LF line-endings.

The default value is true.

top
I
public int I {get; set; }
Introduced in version 9.5.0.56

The value of the "i" index to be used when evaluating a JSON path.

top
J
public int J {get; set; }
Introduced in version 9.5.0.56

The value of the "j" index to be used when evaluating a JSON path.

top
K
public int K {get; set; }
Introduced in version 9.5.0.56

The value of the "k" index to be used when evaluating a JSON path.

top
LastErrorHtml
public string LastErrorHtml {get; }

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
public string LastErrorText {get; }

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
public string LastErrorXml {get; }

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Size
public int Size {get; }
Introduced in version 9.5.0.56

The number of name/value members in this JSON object.

top
VerboseLogging
public bool VerboseLogging {get; set; }

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
public string Version {get; }

Version of the component/library, such as "9.5.0.63"

top

Methods

AddArrayAt
public bool AddArrayAt(int index, string name);
Introduced in version 9.5.0.56

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddBoolAt
public bool AddBoolAt(int index, string name, bool value);
Introduced in version 9.5.0.56

Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddIntAt
public bool AddIntAt(int index, string name, int value);
Introduced in version 9.5.0.56

Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddNullAt
public bool AddNullAt(int index, string name);
Introduced in version 9.5.0.56

Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddNumberAt
public bool AddNumberAt(int index, string name, string numericStr);
Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddObjectAt
public bool AddObjectAt(int index, string name);
Introduced in version 9.5.0.56

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AddStringAt
public bool AddStringAt(int index, string name, string value);
Introduced in version 9.5.0.56

Inserts a new string member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
AppendArray
public JsonArray AppendArray(string name);
Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Important: The name is the member name, it is not a JSON path.

Returns null on failure

top
AppendBool
public bool AppendBool(string name, bool value);
Introduced in version 9.5.0.58

Appends a new boolean member. (This is the same as passing -1 to the AddBoolAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateBool instead.

Returns true for success, false for failure.

top
AppendInt
public bool AppendInt(string name, int value);
Introduced in version 9.5.0.58

Appends a new integer member. (This is the same as passing an index of -1 to the AddIntAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateInt instead.

Returns true for success, false for failure.

top
AppendObject
public JsonObject AppendObject(string name);
Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Important: The name is the member name, it is not a JSON path.

Returns null on failure

top
AppendString
public bool AppendString(string name, string value);
Introduced in version 9.5.0.58

Appends a new string member. (This is the same as passing -1 to the AddStringAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateString instead.

Returns true for success, false for failure.

top
AppendStringArray
public bool AppendStringArray(string name, StringTable values);
Introduced in version 9.5.0.67

Appends an array of string values.

Important: The name is the member name, it is not a JSON path.

Returns true for success, false for failure.

top
ArrayAt
public JsonArray ArrayAt(int index);
Introduced in version 9.5.0.56

Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

top
ArrayOf
public JsonArray ArrayOf(string jsonPath);
Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns null on failure

top
BoolAt
public bool BoolAt(int index);
Introduced in version 9.5.0.56

Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

top
BoolOf
public bool BoolOf(string jsonPath);
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

top
BytesOf
public bool BytesOf(string jsonPath, string encoding, BinData bd);
Introduced in version 9.5.0.68

Appends the binary bytes at the specified jsonPath to bd. The encoding indicates the encoding of the bytes, such as "base64", "hex", etc.

Returns true for success, false for failure.

top
Clear
public void Clear();
Introduced in version 9.5.0.76

Clears the contents of the JSON object. This is the equivalent of calling jsonObject.Load("{}")

top
Clone
public JsonObject Clone();
Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns null on failure

top
DateOf
public bool DateOf(string jsonPath, CkDateTime dateTime);
Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located at jsonPath. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns true for success, false for failure.

top
Delete
public bool Delete(string name);
Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns true for success, false for failure.

top
DeleteAt
public bool DeleteAt(int index);
Introduced in version 9.5.0.56

Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
DtOf
public bool DtOf(string jsonPath, bool bLocal, DtObj dt);
Introduced in version 9.5.0.73

Fills the dt with the date/time string located at jsonPath. If bLocal is true, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns true for success, false for failure.

top
Emit
public string Emit();
Introduced in version 9.5.0.56

Writes the JSON document (rooted at the caller) and returns as a string.

Returns null on failure

top
EmitSb
public bool EmitSb(StringBuilder sb);
Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns true for success, false for failure.

top
EmitWithSubs
public string EmitWithSubs(Hashtable subs, bool omitEmpty);
Introduced in version 9.5.0.67

Emits the JSON document with variable substitutions applied. If omitEmpty is true, then members having empty strings or empty arrays are omitted.

Returns null on failure

top
FindObjectWithMember
public JsonObject FindObjectWithMember(string name);
Introduced in version 9.5.0.67

Recursively searches the JSON subtree rooted at the caller's node for a JSON object containing a member having a specified name. (If the caller is the root node of the entire JSON document, then the entire JSON document is searched.) Returns the first match or null if not found.

Returns null on failure

top
FindRecord
public JsonObject FindRecord(string arrayPath, string relPath, string value, bool caseSensitive);
Introduced in version 9.5.0.63

Finds a JSON record in an array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns null on failure

top
FindRecordString
public string FindRecordString(string arrayPath, string relPath, string value, bool caseSensitive, string retRelPath);
Introduced in version 9.5.0.63

Finds a JSON value in an record array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns null on failure

top
FirebaseApplyEvent
public bool FirebaseApplyEvent(string name, string data);
Introduced in version 9.5.0.58

Applies a Firebase event to the JSON. The data contains JSON having a format such as

{"path": "/", "data": {"a": 1, "b": 2}}
The name should be "put" or "patch".

Returns true for success, false for failure.

top
FirebasePatch
public bool FirebasePatch(string jsonPath, string jsonData);
Introduced in version 9.5.0.58

For each key in the jsonData, update (or add) the corresponding key in the JSON at the given jsonPath. The jsonPath is relative to this JSON object. (This is effectively applying a Firebase patch event.)

Returns true for success, false for failure.

top
FirebasePut
public bool FirebasePut(string jsonPath, string value);
Introduced in version 9.5.0.58

Inserts or replaces the value at the jsonPath. The value can contain JSON text, an integer (in decimal string format), a boolean (true/false), the keyword "null", or a quoted string.

The jsonPath is relative to this JSON object. (This is effectively applying a Firebase put event.)

Returns true for success, false for failure.

top
GetDocRoot
public JsonObject GetDocRoot();
Introduced in version 9.5.0.56

Returns the root of the JSON document. The root can be obtained from any JSON object within the JSON document. The entire JSON document remains in memory as long as at least one JSON object is referenced by the application. When the last reference is removed, the entire JSON document is automatically dellocated.

Returns null on failure

top
HasMember
public bool HasMember(string jsonPath);
Introduced in version 9.5.0.58

Returns true if the item at the jsonPath exists.

Returns true for success, false for failure.

top
IndexOf
public int IndexOf(string name);
Introduced in version 9.5.0.56

Returns the index of the member having the given name. Returns -1 if the name is not found.

top
IntAt
public int IntAt(int index);
Introduced in version 9.5.0.56

Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

top
IntOf
public int IntOf(string jsonPath);
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

top
IsNullAt
public bool IsNullAt(int index);
Introduced in version 9.5.0.56

Returns the boolean value of the member having the specified index.

top
IsNullOf
public bool IsNullOf(string jsonPath);
Introduced in version 9.5.0.56

Returns true if the value at the specified jsonPath is null. Otherwise returns false.

top
Load
public bool Load(string json);
Introduced in version 9.5.0.56

Parses a JSON string and loads it into this JSON object to provide DOM-style access.

Returns true for success, false for failure.

top
LoadFile
public bool LoadFile(string path);
Introduced in version 9.5.0.56

Loads a JSON file into this JSON object. The path is the file path to the JSON file.

Returns true for success, false for failure.

top
LoadPredefined
public bool LoadPredefined(string name);
Introduced in version 9.5.0.67

Loads this JSON object from a predefined document having a specified name.

Returns true for success, false for failure.

top
LoadSb
public bool LoadSb(StringBuilder sb);
Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns true for success, false for failure.

top
NameAt
public string NameAt(int index);
Introduced in version 9.5.0.56

Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

top
ObjectAt
public JsonObject ObjectAt(int index);
Introduced in version 9.5.0.56

Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

top
ObjectOf
public JsonObject ObjectOf(string jsonPath);
Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns null on failure

top
Predefine
public bool Predefine(string name);
Introduced in version 9.5.0.67

Adds or replaces this JSON to an internal global set of predefined JSON documents that can be subsequently loaded by name.

Returns true for success, false for failure.

top
Rename
public bool Rename(string oldName, string newName);
Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns true for success, false for failure.

top
RenameAt
public bool RenameAt(int index, string name);
Introduced in version 9.5.0.56

Renames the member at index to name.

Returns true for success, false for failure.

top
SaveLastError
public bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SetBoolAt
public bool SetBoolAt(int index, bool value);
Introduced in version 9.5.0.56

Sets the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetBoolOf
public bool SetBoolOf(string jsonPath, bool value);
Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns true for success, false for failure.

top
SetIntAt
public bool SetIntAt(int index, int value);
Introduced in version 9.5.0.56

Sets the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetIntOf
public bool SetIntOf(string jsonPath, int value);
Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns true for success, false for failure.

top
SetNullAt
public bool SetNullAt(int index);
Introduced in version 9.5.0.56

Sets the value of the Nth member to null. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetNullOf
public bool SetNullOf(string jsonPath);
Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns true for success, false for failure.

top
SetNumberAt
public bool SetNumberAt(int index, string value);
Introduced in version 9.5.0.56

Sets the numeric value of the Nth member. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetNumberOf
public bool SetNumberOf(string jsonPath, string value);
Introduced in version 9.5.0.56

Sets the numeric value at the specified jsonPath. The value is an integer, float, or double already converted to a string in the format desired by the application.

Returns true for success, false for failure.

top
SetStringAt
public bool SetStringAt(int index, string value);
Introduced in version 9.5.0.56

Sets the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns true for success, false for failure.

top
SetStringOf
public bool SetStringOf(string jsonPath, string value);
Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns true for success, false for failure.

top
SizeOfArray
public int SizeOfArray(string jsonPath);
Introduced in version 9.5.0.56

Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.

top
StringAt
public string StringAt(int index);
Introduced in version 9.5.0.56

Returns the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

top
StringOf
public string StringOf(string jsonPath);
Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns null on failure

top
StringOfSb
public bool StringOfSb(string jsonPath, StringBuilder sb);
Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns true for success, false for failure.

top
Swap
public bool Swap(int index1, int index2);
Introduced in version 9.5.0.76

Swaps the positions of members at index1 and index2.

Returns true for success, false for failure.

top
TypeAt
public int TypeAt(int index);
Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

  1. string
  2. number
  3. object
  4. array
  5. boolean
  6. null
Returns -1 if no member exists at the given index.

top
UpdateBd
public bool UpdateBd(string jsonPath, string encoding, BinData bd);
Introduced in version 9.5.0.68

Updates or appends a new string member with the encoded contents of bd. If the full path specified by jsonPath does not exist, it is automatically created as needed. The bytes contained in bd are encoded according to encoding (such as "base64", "hex", etc.)

Returns true for success, false for failure.

top
UpdateBool
public bool UpdateBool(string jsonPath, bool value);
Introduced in version 9.5.0.63

Updates or appends a new boolean member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateInt
public bool UpdateInt(string jsonPath, int value);
Introduced in version 9.5.0.63

Updates or appends a new integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNewArray
public bool UpdateNewArray(string jsonPath);
Introduced in version 9.5.0.75

Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNewObject
public bool UpdateNewObject(string jsonPath);
Introduced in version 9.5.0.75

Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNull
public bool UpdateNull(string jsonPath);
Introduced in version 9.5.0.65

Updates or appends a null member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateNumber
public bool UpdateNumber(string jsonPath, string numericStr);
Introduced in version 9.5.0.65

Updates or appends a new numeric member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateSb
public bool UpdateSb(string jsonPath, StringBuilder sb);
Introduced in version 9.5.0.68

Updates or appends a new string member with the contents of sb. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns true for success, false for failure.

top
UpdateString
public bool UpdateString(string jsonPath, string value);
Introduced in version 9.5.0.63

Updates or appends a new string member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Important: Prior to version 9.5.0.68, the string passed in to this method did not get properly JSON escaped. This could cause problems if non-us-ascii chars are present, or if certain special chars such as quotes, CR's, or LF's are present. Version 9.5.0.68 fixes the problem.

Returns true for success, false for failure.

top
WriteFile
public bool WriteFile(string path);
Introduced in version 9.5.0.76

Saves the JSON to a file.

Returns true for success, false for failure.

top