JsonObject

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.

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.)

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.

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.

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

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

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

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.

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.

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.

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.

If True then all member names are converted to lowercase when the JSON is initially loaded by the following methods: Load, LoadBd, LoadSb, LoadFile.

The default value is False.

A prefix string that is automatically added to the JSON path passed in the first argument for other methods (such as StringOf, UpdateString, SetBoolOf, SizeOfArray, etc.)

The default value is the empty string.

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

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

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.

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

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.

Inserts a copy of a JSON array 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.

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.

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.

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.

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.

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.

Inserts a copy of a JSON object 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.

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.

Appends a new and empty JSON array and returns it.

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

Returns None on failure

Appends a copy of a JSON array.

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

Returns True for success, False for failure.

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.

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.

Appends a new and empty JSON object and returns it.

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

Returns None on failure

Appends a copy of a JSON object.

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

Returns True for success, False for failure.

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.

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.

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

Returns None on failure

Returns the JSON array at the specified jsonPath.

Returns None on failure

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

Returns the boolean at the specified jsonPath.

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.

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

Returns a copy of this JSON object.

Returns None on failure

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.

Deletes the member at having the name specified by name. Note: The name is not a tag path. It is the name of a member of this JSON object.

Returns True for success, False for failure.

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

Returns True for success, False for failure.

Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.

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.

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

Returns None on failure

Emits (appends) to the contents of bd.

Returns True for success, False for failure.

Appends the JSON to a StringBuilder object.

Returns True for success, False for failure.

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

Returns None on failure

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 None if not found.

Returns None on failure

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 None on failure

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 None on failure

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

{"path": "/", "data": {"a": 1, "b": 2}}

Returns True for success, False for failure.

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.

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.

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 None on failure

Returns True if the item at the jsonPath exists.

Returns True for success, False for failure.

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

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

Returns the integer at the specified jsonPath.

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

Returns True if the value at the specified jsonPath is null. Otherwise returns False.

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

1. 1 - string
2. 2- number
3. 3- object
4. 4- array
5. 5- boolean
6. 6- null

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

Returns True for success, False for failure.

Loads the contents of bd.

Returns True for success, False for failure.

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.

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

Returns True for success, False for failure.

Loads JSON from the contents of a StringBuilder object.

Returns True for success, False for failure.

Move the member from fromIndex to toIndex. If toIndex equals -1, then moves the member at position fromIndex to the last position. Set toIndex = 0 to move a member to the first position.

Returns True for success, False for failure.

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

Returns None on failure

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

Returns None on failure

Returns the JSON object at the specified jsonPath.

Returns None on failure

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.

Renames the member named oldName to newName.

Returns True for success, False for failure.

Renames the member at index to name.

Returns True for success, False for failure.

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.

Sets the boolean value at the specified jsonPath.

Returns True for success, False for failure.

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.

Sets the integer at the specified jsonPath.

Returns True for success, False for failure.

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.

Sets the value at the specified jsonPath to null.

Returns True for success, False for failure.

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.

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.

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.

Sets the string value at the specified jsonPath.

Returns True for success, False for failure.

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

Sorts the JSON members by the member name.

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

Returns None on failure

Returns the string value at the specified jsonPath.

Returns None on failure

Returns True if the string value at the specified jsonPath equals value. Otherwise returns False

Appends the string value at the specified jsonPath to sb.

Returns True for success, False for failure.

Swaps the positions of members at index1 and index2.

Returns True for success, False for failure.

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 the unsigned integer at the specified jsonPath.

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.

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.

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.

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.

Updates or appends a new and empty JSON object 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.

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.

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.

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.

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.

Updates or appends a new unsigned 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.

Saves the JSON to a file.

Returns True for success, False for failure.