JsonObject Excel Class Module Reference Documentation

JsonObject

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

Dim oJsonObject As Chilkat.JsonObject
Set oJsonObject = Chilkat.NewJsonObject

Properties

DebugLogFilePath As String

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.

DelimiterChar As String

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

EmitCompact As Long

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.

EmitCrLf As Long

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.

I As Long

Introduced in version 9.5.0.56

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

JSON Paths

J As Long

Introduced in version 9.5.0.56

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

K As Long

Introduced in version 9.5.0.56

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

LastErrorHtml As String (read only)

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.

LastErrorText As String (read only)

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read only)

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.

LastMethodSuccess As Long

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.

Size As Long (read only)

Introduced in version 9.5.0.56

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

JSON Iterate Members

VerboseLogging As Long

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 As String (read only)

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

Methods

AddArrayAt(index As Long, name As String) As Long

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.

Create more Complex JSON Document

AddBoolAt(index As Long, name As String, value As Boolean) As Long

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.

JSON: Miscellaneous Operations

AddIntAt(index As Long, name As String, value As Long) As Long

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.

Create JSON Document

AddNullAt(index As Long, name As String) As Long

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.

JSON: Miscellaneous Operations

AddNumberAt(index As Long, name As String, numericStr As String) As Long

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.

Create more Complex JSON Document

AddObjectAt(index As Long, name As String) As Long

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.

Create more Complex JSON Document

AddStringAt(index As Long, name As String, value As String) As Long

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.

Create JSON Document

AppendArray(name As String) As JsonArray

Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Returns Nothing on failure

AppendBool(name As String, value As Boolean) As Long

Introduced in version 9.5.0.58

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

Returns True for success, False for failure.

AppendInt(name As String, value As Long) As Long

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

Returns True for success, False for failure.

AppendObject(name As String) As JsonObject

Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Returns Nothing on failure

AppendString(name As String, value As String) As Long

Introduced in version 9.5.0.58

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

Returns True for success, False for failure.

AppendStringArray(name As String, values As StringTable) As Long

Introduced in version 9.5.0.67

Appends an array of string values.

Returns True for success, False for failure.

JSON Append String Array

ArrayAt(index As Long) As JsonArray

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

Create more Complex JSON Document

ArrayOf(jsonPath As String) As JsonArray

Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns Nothing on failure

JSON: Access Array Values

Modify Parts of JSON Document

JSON Paths

BoolAt(index As Long) As Long

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

JSON: Miscellaneous Operations

BoolOf(jsonPath As String) As Long

Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

JSON: Miscellaneous Operations

JSON Paths

BytesOf(jsonPath As String, encoding As String, bd As BinData) As Long

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.

Clone() As JsonObject

Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns Nothing on failure

Delete(name As String) As Long

Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns True for success, False for failure.

JSON: Renaming and Deleting Members

DeleteAt(index As Long) As Long

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.

JSON: Renaming and Deleting Members

Emit() As String

Introduced in version 9.5.0.56

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

Returns Nothing on failure

Pretty Print JSON (Formatter, Beautifier)

EmitSb(sb As StringBuilder) As Long

Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns True for success, False for failure.

EmitWithSubs(subs As Hashtable, omitEmpty As Boolean) As String

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

Using Pre-defined JSON Templates

FindObjectWithMember(name As String) As JsonObject

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

Returns Nothing on failure

FindRecord(arrayPath As String, relPath As String, value As String, caseSensitive As Boolean) As JsonObject

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

JSON FindRecord Example

FindRecordString(arrayPath As String, relPath As String, value As String, caseSensitive As Boolean, retRelPath As String) As String

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

JSON FindRecordString Example

FirebaseApplyEvent(name As String, data As String) As Long

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.

Firebase Receive Server-Sent Events (text/event-stream)

FirebasePatch(jsonPath As String, jsonData As String) As Long

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.

Firebase JSON Put and Patch

FirebasePut(jsonPath As String, value As String) As Long

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.

Firebase JSON Put and Patch

GetDocRoot() As JsonObject

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

Get the Root of a JSON Document

HasMember(jsonPath As String) As Long

Introduced in version 9.5.0.58

Returns True if the item at the jsonPath exists.

Returns True for success, False for failure.

IndexOf(name As String) As Long

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.

Get the Index of a JSON Member

IntAt(index As Long) As Long

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

JSON Iterate Members

IntOf(jsonPath As String) As Long

Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

JSON: Miscellaneous Operations

JSON Paths

IsNullAt(index As Long) As Long

Introduced in version 9.5.0.56

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

JSON: Miscellaneous Operations

IsNullOf(jsonPath As String) As Long

Introduced in version 9.5.0.56

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

JSON: Miscellaneous Operations

JSON Paths

Load(json As String) As Long

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.

Load JSON Data at Path

Load a JSON Array

Loading and Parsing a JSON Array

LoadFile(path As String) As Long

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.

Load a JSON Array

LoadPredefined(name As String) As Long

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.

Using Pre-defined JSON Templates

LoadSb(sb As StringBuilder) As Long

Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns True for success, False for failure.

NameAt(index As Long) As String

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

JSON Iterate Members

ObjectAt(index As Long) As JsonObject

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

Create more Complex JSON Document

ObjectOf(jsonPath As String) As JsonObject

Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns Nothing on failure

JSON: Nested Objects

JSON Paths

Predefine(name As String) As Long

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.

Using Pre-defined JSON Templates

Rename(oldName As String, newName As String) As Long

Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns True for success, False for failure.

JSON: Renaming and Deleting Members

RenameAt(index As Long, name As String) As Long

Introduced in version 9.5.0.56

Renames the member at index to name.

Returns True for success, False for failure.

JSON: Renaming and Deleting Members

SetBoolAt(index As Long, value As Boolean) As Long

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.

Modify Parts of JSON Document

SetBoolOf(jsonPath As String, value As Boolean) As Long

Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns True for success, False for failure.

Modify Parts of JSON Document

JSON Paths

SetIntAt(index As Long, value As Long) As Long

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.

Modify Parts of JSON Document

SetIntOf(jsonPath As String, value As Long) As Long

Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns True for success, False for failure.

Modify Parts of JSON Document

JSON Paths

SetNullAt(index As Long) As Long

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.

JSON: Miscellaneous Operations

SetNullOf(jsonPath As String) As Long

Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns True for success, False for failure.

JSON: Miscellaneous Operations

JSON Paths

SetNumberAt(index As Long, value As String) As Long

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.

JSON: Miscellaneous Operations

SetNumberOf(jsonPath As String, value As String) As Long

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.

JSON: Miscellaneous Operations

JSON Paths

SetStringAt(index As Long, value As String) As Long

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.

Modify Parts of JSON Document

SetStringOf(jsonPath As String, value As String) As Long

Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns True for success, False for failure.

Modify Parts of JSON Document

JSON Paths

SizeOfArray(jsonPath As String) As Long

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.

JSON Paths

StringAt(index As Long) As String

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

JSON Iterate Members

StringOf(jsonPath As String) As String

Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns Nothing on failure

JSON: Miscellaneous Operations

JSON Paths

JSON Paths that need Double Quotes

StringOfSb(jsonPath As String, sb As StringBuilder) As Long

Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns True for success, False for failure.

TypeAt(index As Long) As Long

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.

UpdateBd(jsonPath As String, encoding As String, bd As BinData) As Long

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.

UpdateBool(jsonPath As String, value As Boolean) As Long

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.

UpdateInt(jsonPath As String, value As Long) As Long

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.

UpdateNull(jsonPath As String) As Long

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.

UpdateNumber(jsonPath As String, numericStr As String) As Long

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.

UpdateSb(jsonPath As String, sb As StringBuilder) As Long

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.

UpdateString(jsonPath As String, value As String) As Long

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.

JSON UpdateString