JsonObject Xojo Plugin Reference Documentation

JsonObject

Current Version: 11.5.0

Chilkat.JsonObject

Load, navigate, create, modify, search, sort, and emit JSON objects.

Chilkat.JsonObject provides DOM-style access to JSON objects. It can load, inspect, modify, create, search, sort, emit, and save JSON data. It supports path-based access, index-based member access, automatic creation of nested paths, object and array references, Firebase-style updates, record searches, date/time conversion, binary data encoding, variable substitution, and optional secure secret resolution.

Load and emit JSON

Load JSON from strings, files, buffers, or Chilkat objects, then emit the result as compact or pretty-formatted JSON.

Path-based navigation

Read and update nested values using JSON paths, with support for automatically creating missing object or array paths.

Member access

Access object members by name or index, inspect member types, retrieve values, and remove or rename members as needed.

Nested objects and arrays

Work directly with child JsonObject and JsonArray references to navigate and modify complex JSON structures.

Search and transform

Search records, sort object members, perform Firebase-style updates, and prepare JSON for API requests or application storage.

Special value handling

Handle date/time values, binary data encodings, exact numeric text, variable substitution, and secure secret resolution.

Common pattern: Load or create a JsonObject, navigate named members and nested paths, retrieve child arrays as JsonArray objects when ordered lists are encountered, update values as needed, then emit or save the final JSON. Use JsonObject for named JSON members and JsonArray for ordered lists.

For an extended overview, see JsonObject Class Overview.

Object Creation

Dim jsonObject As New Chilkat.JsonObject

Properties

DebugLogFilePath
DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
DelimiterChar
DelimiterChar As String
Introduced in version 9.5.0.58

Specifies the character used to separate object-member names in Chilkat JSON paths. The default is .. Set it to / for Firebase-style paths. This property should contain exactly one character.

Arrays in paths: Array indexes continue to use square brackets, such as orders[0].id. If a member name itself contains a path-separator character, quote that path component with double quotes.

top
EmitCompact
EmitCompact As Boolean
Introduced in version 9.5.0.56

Controls whether emitted JSON is compact or pretty-printed. The default is True.

TrueEmit a compact representation with no extra formatting whitespace.
FalseEmit indented, human-readable JSON.
JSON semantics: Formatting whitespace does not change the JSON data. Use compact output for transport/storage and pretty output for diagnostics or human review.

top
EmitCrLf
EmitCrLf As Boolean
Introduced in version 9.5.0.56

Controls line endings when pretty-printed JSON is emitted (EmitCompact = False). The default is True.

TrueUse CRLF line endings.
FalseUse LF line endings.
Compact output: This setting has no effect when EmitCompact is True because compact JSON is emitted without formatting line breaks.

top
EnableSecrets
EnableSecrets As Boolean
Introduced in version 11.5.0

Enables automatic resolution of Chilkat secret specification strings for supported string-setting methods. The default is False. When enabled, a value beginning with !! can identify a credential stored in Windows Credential Manager or Apple Keychain instead of embedding the literal secret in application code.

Secret specification format: !![appName|]service[|domain]|username.

This feature applies to AddStringAt, AppendString, SetStringAt, SetStringOf, UpdateSb, and UpdateString.

Security: Secret resolution changes where the string value comes from; the resulting JSON member still contains the resolved value. Avoid emitting or logging JSON that contains credentials unless that exposure is explicitly intended.

More Information and Examples
More Detailed Information About EnableSecrets
top
I
I As Int32
Introduced in version 9.5.0.56

Supplies the integer substituted for i when a JSON path contains an array index such as [i]. This is useful for loop-based navigation without constructing a new path string for every iteration.

Related properties: The J and K properties provide the same substitution behavior for [j] and [k].

More Information and Examples
JSON Paths
top
J
J As Int32
Introduced in version 9.5.0.56

Supplies the integer substituted for j when a JSON path contains [j]. It is commonly used with nested-array paths such as matrix[i][j].

top
K
K As Int32
Introduced in version 9.5.0.56

Supplies the integer substituted for k when a JSON path contains [k]. It can be combined with I and J for deeper nested-array traversal.

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
LowerCaseNames
LowerCaseNames As Boolean
Introduced in version 9.5.0.87

If True, member names are converted to lowercase while JSON is loaded by Load, LoadBd, LoadSb, or LoadFile. The default is False.

Important: This changes member names in the parsed document; it is not merely a case-insensitive lookup mode. Use it only when normalizing names is intentional.

top
PathPrefix
PathPrefix As String
Introduced in version 9.5.0.76

Specifies a path prefix automatically prepended to JSON paths passed to path-based methods such as StringOf, ObjectOf, UpdateString, SetBoolOf, and SizeOfArray. The default is the empty string.

Use case: Set a prefix when many operations target the same nested object. The individual method calls can then use paths relative to that prefix.

More Information and Examples
JSON PathPrefix Example
top
Size
Size As Int32 (read-only)
Introduced in version 9.5.0.56

Returns the number of direct name/value members in this JSON object. Nested members inside child objects are not included.

JSON objects and order: RFC 8259 defines a JSON object as an unordered collection of name/value pairs. Chilkat preserves a member order so index-based APIs and deterministic emission are possible, but interoperable application logic should generally use member names rather than depend on object order.

More Information and Examples
JSON Iterate Members
top
UncommonOptions
UncommonOptions As String
Introduced in version 9.5.0.90

Provides a catch-all string for uncommon, implementation-specific options. The default is the empty string and it should normally remain empty.

Recommendation: Do not invent option keywords. Set this property only when a specific JsonObject option is documented by Chilkat or provided by Chilkat support.

top
VerboseLogging
VerboseLogging As Boolean

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

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AddArrayAt
Function AddArrayAt(index As Int32, name As String) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON array member named name at the zero-based member position index. The new array is empty.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
Create more Complex JSON Document
top
AddArrayCopyAt
Function AddArrayCopyAt(index As Int32, name As String, jarr As Chilkat.JsonArray) As Boolean
Introduced in version 9.5.0.82

Inserts a new JSON array member named name at the zero-based member position index. The array value is copied from jarr; subsequent changes to the source array do not modify the inserted copy.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
JSON AddArrayCopyAt Example
top
AddBoolAt
Function AddBoolAt(index As Int32, name As String, value As Boolean) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON boolean member named name at the zero-based member position index. The value is taken from value.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
AddIntAt
Function AddIntAt(index As Int32, name As String, value As Int32) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON number member named name at the zero-based member position index. The integer value is emitted as a JSON number, not as a quoted string.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
Create JSON Document
top
AddNullAt
Function AddNullAt(index As Int32, name As String) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON null member named name at the zero-based member position index.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
AddNumberAt
Function AddNumberAt(index As Int32, name As String, numericStr As String) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON number member named name at the zero-based member position index. The numericStr argument supplies the exact JSON numeric text to store.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.
Exact numeric text: Use this method when lexical form or precision matters, for example 12345678901234567890, 1.2500, or scientific notation. The supplied text must be valid JSON number syntax; JSON does not permit NaN or infinity.

Returns True for success, False for failure.

More Information and Examples
Create more Complex JSON Document
top
AddObjectAt
Function AddObjectAt(index As Int32, name As String) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON object member named name at the zero-based member position index. The new object is empty.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
Create more Complex JSON Document
top
AddObjectCopyAt
Function AddObjectCopyAt(index As Int32, name As String, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 9.5.0.82

Inserts a new JSON object member named name at the zero-based member position index. The object value is copied from jsonObj; the inserted value is independent of the source.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
JSON AddObjectCopyAt Example
top
AddStringAt
Function AddStringAt(index As Int32, name As String, value As String) As Boolean
Introduced in version 9.5.0.56

Inserts a new JSON string member named name at the zero-based member position index. The value is stored as a JSON string and is escaped as needed when emitted.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

Returns True for success, False for failure.

More Information and Examples
Create JSON Document
top
AppendArray
Function AppendArray(name As String) As Chilkat.JsonArray
Introduced in version 9.5.0.58

Appends a new JSON array member named name to this object. The newly appended array is empty and the returned JsonArray references that array in this document, so changes made through it modify the same JSON tree.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns Nil on failure

More Information and Examples
JSON AppendArray Example
top
AppendArray2
Function AppendArray2(name As String, jarr As Chilkat.JsonArray) As Boolean
Introduced in version 11.0.0

Appends a new JSON array member named name to this object. A new empty array is created and jarr is updated to reference it. The method returns True on success.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

top
AppendArrayCopy
Function AppendArrayCopy(name As String, jarr As Chilkat.JsonArray) As Boolean
Introduced in version 9.5.0.82

Appends a new JSON array member named name to this object. The array is copied from jarr, so the appended array is independent of the source array.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

More Information and Examples
JSON AppendArrayCopy Example
top
AppendBool
Function AppendBool(name As String, value As Boolean) As Boolean
Introduced in version 9.5.0.58

Appends a new JSON boolean member named name to this object. The value is taken from value.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

top
AppendInt
Function AppendInt(name As String, value As Int32) As Boolean
Introduced in version 9.5.0.58

Appends a new JSON number member named name to this object. The integer value is stored as a JSON number.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

top
AppendObject
Function AppendObject(name As String) As Chilkat.JsonObject
Introduced in version 9.5.0.58

Appends a new JSON object member named name to this object. The newly appended object is empty and the returned JsonObject references that object in this document.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns Nil on failure

More Information and Examples
JSON AppendObject Example
top
AppendObject2
Function AppendObject2(name As String, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Appends a new JSON object member named name to this object. A new empty object is created and jsonObj is updated to reference it. The method returns True on success.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

top
AppendObjectCopy
Function AppendObjectCopy(name As String, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 9.5.0.82

Appends a new JSON object member named name to this object. The object is copied from jsonObj, so the appended object is independent of the source object.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

More Information and Examples
JSON AppendObjectCopy Example
top
AppendString
Function AppendString(name As String, value As String) As Boolean
Introduced in version 9.5.0.58

Appends a new JSON string member named name to this object. The value is JSON-escaped as needed when emitted.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

top
AppendStringArray
Function AppendStringArray(name As String, values As Chilkat.StringTable) As Boolean
Introduced in version 9.5.0.67

Appends a new JSON array member named name to this object. The array is populated with the strings contained in values.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns True for success, False for failure.

More Information and Examples
JSON Append String Array
top
ArrayAt
Function ArrayAt(index As Int32) As Chilkat.JsonArray
Introduced in version 9.5.0.56

Returns the JSON array stored in the member at zero-based position index. The returned JsonArray references the existing array in the same document; it is not a detached copy.

Type requirement: The member at index must be an array. Use TypeAt when the member type is not already known.

Returns Nil on failure

More Information and Examples
Create more Complex JSON Document
top
ArrayAt2
Function ArrayAt2(index As Int32, jarr As Chilkat.JsonArray) As Boolean
Introduced in version 11.0.0

Updates jarr to reference the JSON array stored at zero-based member position index and returns True on success.

Returns True for success, False for failure.

top
ArrayOf
Function ArrayOf(jsonPath As String) As Chilkat.JsonArray
Introduced in version 9.5.0.56

Returns the JSON array at jsonPath. The returned JsonArray references the existing array in the same document, so modifications through it are reflected in the parent JSON.

JSON paths: Paths are relative to this object and may include object-member separators and array indexes, for example orders[0].items.

Returns Nil on failure

More Information and Examples
JSON: Access Array ValuesModify Parts of JSON DocumentJSON Paths
top
ArrayOf2
Function ArrayOf2(jsonPath As String, jarr As Chilkat.JsonArray) As Boolean
Introduced in version 11.1.0

Updates jarr to reference the JSON array at jsonPath and returns True on success.

Returns True for success, False for failure.

top
BoolAt
Function BoolAt(index As Int32) As Boolean
Introduced in version 9.5.0.56

Returns the boolean value of the member at zero-based position index.

Indexing: Member indexes are based on the order maintained by this JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.
More Information and Examples
JSON: Miscellaneous Operations
top
BoolOf
Function BoolOf(jsonPath As String) As Boolean
Introduced in version 9.5.0.56

Returns the boolean value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
BytesOf
Function BytesOf(jsonPath As String, encoding As String, bd As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.68

Reads the string value at jsonPath, decodes it using encoding (for example, base64 or hex), and appends the resulting bytes to bd.

Binary-in-JSON convention: The JSON member itself is text. The encoding argument tells Chilkat how that text represents the original bytes.

Returns True for success, False for failure.

More Information and Examples
Read/Write JSON with Binary Data such as JPEG Files
top
Clear
Sub Clear()
Introduced in version 9.5.0.76

Removes all members from this JSON object, leaving an empty object equivalent to {}.

top
CopyRef
Function CopyRef(jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Updates jsonObj so that it references the same JSON object as the caller. No JSON data is copied.

Shared state: After this call, modifications through either reference affect the same underlying JSON object.

Returns True for success, False for failure.

top
DateOf
Function DateOf(jsonPath As String, dateTime As Chilkat.CkDateTime) As Boolean
Introduced in version 9.5.0.73

Parses the date/time value at jsonPath and loads the result into dateTime. Recognized forms include ISO 8601 timestamps (for example, 2009-11-04T19:55:41Z), RFC 822-style date/time strings, and Unix timestamp integers.

JSON has no native date type: Dates in JSON are application conventions, usually represented as strings or numbers. This method recognizes common conventions and converts them to CkDateTime.

Returns True for success, False for failure.

More Information and Examples
JSON Date ParsingParse a Microsoft JSON Date (MS AJAX Date)
top
Delete
Function Delete(name As String) As Boolean
Introduced in version 9.5.0.56

Deletes the direct member named name from this JSON object.

Not a path: name is a member name, not a JSON path. Use a path-based operation when deleting or replacing a nested value requires navigation first.

Returns True for success, False for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
DeleteAt
Function DeleteAt(index As Int32) As Boolean
Introduced in version 9.5.0.56

Deletes the member at zero-based position index. Members after the deleted position shift toward the beginning.

Returns True for success, False for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
DeleteRecords
Function DeleteRecords(arrayPath As String, relpath As String, value As String, caseSensitive As Boolean) As Int32
Introduced in version 9.5.0.88

Deletes every object record in the array at arrayPath whose value at relative path relpath equals or wildcard-matches value. The caseSensitive argument controls matching. Returns the number of records deleted.

top
DtOf
Function DtOf(jsonPath As String, bLocal As Boolean, dt As Chilkat.DtObj) As Boolean
Introduced in version 9.5.0.73

Parses the date/time value at jsonPath into dt. If bLocal is True, the destination receives local date/time fields; otherwise it receives UTC/GMT fields. Recognized inputs include ISO 8601 timestamps, RFC 822-style date/time strings, and Unix timestamp integers.

Returns True for success, False for failure.

More Information and Examples
JSON Date Parsing
top
Emit
Function Emit() As String
Introduced in version 9.5.0.56

Serializes the JSON document rooted at this object and returns the JSON text. Formatting is controlled by EmitCompact and, for pretty output, EmitCrLf.

Object member order: Chilkat emits members in its maintained order, but JSON object ordering is not semantically significant under RFC 8259.

Returns Nil on failure

More Information and Examples
Pretty Print JSON (Formatter, Beautifier)
top
EmitBd
Function EmitBd(bd As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.77

Serializes this JSON and appends the resulting bytes to bd.

Append behavior: Existing data in the destination BinData is preserved.

Returns True for success, False for failure.

top
EmitSb
Function EmitSb(sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.62

Serializes this JSON and appends the resulting text to sb. Formatting follows EmitCompact and EmitCrLf.

Append behavior: Existing text in the destination StringBuilder is preserved; the emitted JSON is added after it.

Returns True for success, False for failure.

top
EmitWithSubs
Function EmitWithSubs(subs As Chilkat.Hashtable, omitEmpty As Boolean) As String
Introduced in version 9.5.0.67

Serializes the JSON after substituting variables from subs into template strings. A placeholder such as {$name} is replaced by the corresponding hashtable value. Prefixing the variable name with i., as in {$i.count}, emits the substituted value as a JSON integer instead of a quoted string.

If omitEmpty is True, members whose substituted result is an empty string or empty array are omitted from the emitted JSON.

Template reuse: This method does not require rebuilding the JSON template. It is commonly paired with Predefine and LoadPredefined when the same JSON shape is emitted repeatedly with different values.

Returns Nil on failure

More Information and Examples
Using Pre-defined JSON Templates
top
FindObjectWithMember
Function FindObjectWithMember(name As String) As Chilkat.JsonObject
Introduced in version 9.5.0.67

Recursively searches this JSON subtree for the first JSON object containing a direct member named name. Returns that object, or Nil if no matching object is found.

Returns Nil on failure

top
FindObjectWithMember2
Function FindObjectWithMember2(name As String, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Recursively searches this JSON subtree for the first object containing a direct member named name. On success, jsonObj is updated to reference the matching object and the method returns True.

Returns True for success, False for failure.

top
FindRecord
Function FindRecord(arrayPath As String, relPath As String, value As String, caseSensitive As Boolean) As Chilkat.JsonObject
Introduced in version 9.5.0.63

Searches the JSON array at arrayPath for the first object whose value at relative path relPath equals or wildcard-matches value. The caseSensitive argument controls string comparison. Returns the matching record object.

Wildcard matching: The search value may contain * to match zero or more characters. relPath is evaluated relative to each record object in the array.

Returns Nil on failure

More Information and Examples
JSON FindRecord Example
top
FindRecord2
Function FindRecord2(arrayPath As String, relPath As String, value As String, caseSensitive As Boolean, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Searches the JSON array at arrayPath using the same matching rules as FindRecord. On success, jsonObj is updated to reference the first matching record and the method returns True.

Reference semantics: The destination references the record in the original JSON document; changes made through jsonObj modify that record.

Returns True for success, False for failure.

top
FindRecordString
Function 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

Searches the JSON array at arrayPath for the first record whose relPath value equals or wildcard-matches value, then returns the value at retRelPath from that same record as a string.

Typical use: This is useful for lookups such as “find the record where Name is Advertising and return its Id.” The * wildcard may be used in value.

Returns Nil on failure

More Information and Examples
JSON FindRecordString Example
top
FirebaseApplyEvent
Function FirebaseApplyEvent(name As String, data As String) As Boolean
Introduced in version 9.5.0.58

Applies a Firebase Realtime Database event to this JSON object. name should be put or patch, and data should contain event JSON such as {"path":"/","data":{"a":1,"b":2}}.

Purpose: This method is useful when maintaining a local JSON representation from Firebase server-sent events: put replaces the value at a path, while patch updates individual child keys.

Returns True for success, False for failure.

More Information and Examples
Firebase Receive Server-Sent Events (text/event-stream)
top
FirebasePatch
Function FirebasePatch(jsonPath As String, jsonData As String) As Boolean
Introduced in version 9.5.0.58

Applies Firebase-style patch semantics at jsonPath. jsonData must contain a JSON object; each key in that object updates or adds the corresponding key at the target path.

Relative path: jsonPath is relative to this JsonObject.

Returns True for success, False for failure.

More Information and Examples
Firebase JSON Put and Patch
top
FirebasePut
Function FirebasePut(jsonPath As String, value As String) As Boolean
Introduced in version 9.5.0.58

Applies Firebase-style put semantics at jsonPath, replacing or inserting the value at that path. value is JSON text and may represent an object, array, number, boolean, null, or a quoted JSON string.

Quoted strings: To store a string through this method, value must contain a valid JSON string literal, including its surrounding double quotes. Use UpdateString when you already have an ordinary application string.

Returns True for success, False for failure.

More Information and Examples
Firebase JSON Put and Patch
top
GetDocRoot
Function GetDocRoot() As Chilkat.JsonObject
Introduced in version 9.5.0.56

Returns a JsonObject reference to the root object of the JSON document containing this object. This can be called from any nested object reference.

Shared document lifetime: Nested JsonObject references share the same underlying JSON document. The document remains available while at least one such reference is retained by the application.

Returns Nil on failure

More Information and Examples
Get the Root of a JSON Document
top
GetDocRoot2
Function GetDocRoot2(docRoot As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Updates docRoot to reference the root object of the JSON document containing the caller and returns True on success.

Reference semantics: The destination is another reference into the same underlying document; it is not a copy.

Returns True for success, False for failure.

top
HasMember
Function HasMember(jsonPath As String) As Boolean
Introduced in version 9.5.0.58

Returns True if a value exists at jsonPath; otherwise returns False.

Missing vs. null: A member whose JSON value is null still exists. Use IsNullOf to test specifically for JSON null.

Returns True for success, False for failure.

top
IndexOf
Function IndexOf(name As String) As Int32
Introduced in version 9.5.0.56

Returns the zero-based position of the direct member named name, or -1 if that member name is not found.

Not a path: name is searched only among the direct members of this object.
More Information and Examples
Get the Index of a JSON Member
top
IntAt
Function IntAt(index As Int32) As Int32
Introduced in version 9.5.0.56

Returns the integer value of the member at zero-based position index.

Indexing: Member indexes are based on the order maintained by this JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.
More Information and Examples
JSON Iterate Members
top
IntOf
Function IntOf(jsonPath As String) As Int32
Introduced in version 9.5.0.56

Returns the integer value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.

Large numbers: Use StringOf or the exact numeric-text APIs when a JSON integer may exceed the range of the language binding's integer type.
More Information and Examples
JSON: Miscellaneous OperationsJSON PathsCheck if Integer Exists at JSON PathDemonstrates how to Handle Large Integers in JSON
top
IsNullAt
Function IsNullAt(index As Int32) As Boolean
Introduced in version 9.5.0.56

Returns True if the member at zero-based position index has the JSON value null; otherwise returns False.

More Information and Examples
JSON: Miscellaneous Operations
top
IsNullOf
Function IsNullOf(jsonPath As String) As Boolean
Introduced in version 9.5.0.56

Returns True if the value at jsonPath is the JSON literal null; otherwise returns False.

Null is a value: JSON null is different from a missing member and from an empty string. Use HasMember when existence must be tested separately.
More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
JsonTypeOf
Function JsonTypeOf(jsonPath As String) As Int32
Introduced in version 9.5.0.68

Returns an integer identifying the JSON type of the value at jsonPath. Returns -1 if no member exists at that path.

1string
2number
3object
4array
5boolean
6null
top
Load
Function Load(json As String) As Boolean
Introduced in version 9.5.0.56

Parses the JSON text in json and loads the parsed data into this object for DOM-style access and modification.

JSON data model: JSON values are strings, numbers, booleans, null, objects, or arrays. Object member names should be unique for interoperable JSON; RFC 8259 notes that consumers differ in how duplicate names are handled.

Returns True for success, False for failure.

More Information and Examples
Load JSON Data at PathLoad a JSON ArrayLoading and Parsing a JSON ArrayUnderstanding JSON Array vs JSON Object
top
LoadBd
Function LoadBd(bd As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.77

Parses JSON from the bytes contained in bd and loads it into this object.

Returns True for success, False for failure.

top
LoadFile
Function LoadFile(path As String) As Boolean
Introduced in version 9.5.0.56

Reads JSON text from the file at path, parses it, and loads the result into this object.

Returns True for success, False for failure.

More Information and Examples
Load a JSON Array
top
LoadPredefined
Function LoadPredefined(name As String) As Boolean
Introduced in version 9.5.0.67

Loads this object from the predefined JSON document identified by name. Predefined documents are created with Predefine.

Returns True for success, False for failure.

More Information and Examples
Using Pre-defined JSON Templates
top
LoadSb
Function LoadSb(sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.62

Parses JSON from the current contents of sb and loads it into this object.

Returns True for success, False for failure.

More Information and Examples
Download a Specific GMail Message into a Chilkat Email Object
top
MakeCopy
Function MakeCopy(json As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Copies this JSON object into json. The destination receives an independent JSON copy rather than another reference to the same underlying object.

Copy vs. reference: Use CopyRef when two JsonObject instances should refer to the same JSON object instead of duplicating its data.

Returns True for success, False for failure.

top
MoveMember
Function MoveMember(fromIndex As Int32, toIndex As Int32) As Boolean
Introduced in version 9.5.0.80

Moves the direct member at zero-based position fromIndex to toIndex. Use toIndex = 0 to move it first or -1 to move it last.

Returns True for success, False for failure.

top
NameAt
Function NameAt(index As Int32) As String
Introduced in version 9.5.0.56

Returns the name of the member at zero-based position index. Use this with Size and TypeAt to iterate through an object's direct members.

Returns Nil on failure

More Information and Examples
JSON Iterate Members
top
NewArrayOf
Function NewArrayOf(path As String, jArr As String) As Boolean
Introduced in version 11.4.0

Creates a JSON array at path and loads that array from the JSON text in jArr. The supplied text should represent a JSON array.

Difference from UpdateNewArray: UpdateNewArray creates an empty array. NewArrayOf creates the array and immediately populates it from JSON text.

Returns True for success, False for failure.

More Information and Examples
Example: JsonObject.NewArrayOf method
top
NewObjectOf
Function NewObjectOf(path As String, jObj As String) As Boolean
Introduced in version 11.4.0

Creates a JSON object at path and loads that object from the JSON text in jObj. The supplied text should represent a JSON object.

Difference from UpdateNewObject: UpdateNewObject creates an empty object. NewObjectOf creates the object and immediately populates it from JSON text.

Returns True for success, False for failure.

More Information and Examples
Example: JsonObject.NewObjectOf method
top
ObjectAt
Function ObjectAt(index As Int32) As Chilkat.JsonObject
Introduced in version 9.5.0.56

Returns the JSON object stored in the member at zero-based position index. The returned JsonObject references the existing child object in the same document; changes made through it modify that document.

Type requirement: The member at index must be a JSON object. Use TypeAt when the type is not already known.

Returns Nil on failure

More Information and Examples
Create more Complex JSON Document
top
ObjectAt2
Function ObjectAt2(index As Int32, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Updates jsonObj to reference the JSON object stored at zero-based member position index and returns True on success.

Returns True for success, False for failure.

top
ObjectOf
Function ObjectOf(jsonPath As String) As Chilkat.JsonObject
Introduced in version 9.5.0.56

Returns the JSON object at jsonPath. The returned object is a live reference into the same JSON document, not a copy.

Relative paths: A path is evaluated relative to the current object. Use GetDocRoot when access must start from the document root.

Returns Nil on failure

More Information and Examples
JSON: Nested ObjectsJSON Paths
top
ObjectOf2
Function ObjectOf2(jsonPath As String, jsonObj As Chilkat.JsonObject) As Boolean
Introduced in version 11.0.0

Updates jsonObj to reference the JSON object at jsonPath and returns True on success.

Returns True for success, False for failure.

top
Predefine
Function Predefine(name As String) As Boolean
Introduced in version 9.5.0.67

Stores this JSON document in Chilkat's internal global collection of predefined JSON documents under name. If the name already exists, the predefined value is replaced.

Template use: After predefining a document, another JsonObject can load it by name with LoadPredefined.

Returns True for success, False for failure.

More Information and Examples
Using Pre-defined JSON Templates
top
Rename
Function Rename(oldName As String, newName As String) As Boolean
Introduced in version 9.5.0.56

Renames the direct member oldName to newName. The member value and its position are otherwise unchanged.

JSON interoperability: JSON object member names should be unique. Avoid renaming a member to a name already used by another member unless duplicate names are intentionally required.

Returns True for success, False for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
RenameAt
Function RenameAt(index As Int32, name As String) As Boolean
Introduced in version 9.5.0.56

Renames the member at zero-based position index to name. The member value is not changed.

Returns True for success, False for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
SetBoolAt
Function SetBoolAt(index As Int32, value As Boolean) As Boolean
Introduced in version 9.5.0.56

Sets the member at zero-based position index to a JSON boolean value.

Returns True for success, False for failure.

More Information and Examples
Modify Parts of JSON Document
top
SetBoolOf
Function SetBoolOf(jsonPath As String, value As Boolean) As Boolean
Introduced in version 9.5.0.56

Sets the value at jsonPath to a JSON boolean value.

Set vs. Update: Use UpdateBool when missing objects or array positions along the path should be created automatically.

Returns True for success, False for failure.

More Information and Examples
Modify Parts of JSON DocumentJSON Paths
top
SetIntAt
Function SetIntAt(index As Int32, value As Int32) As Boolean
Introduced in version 9.5.0.56

Sets the member at zero-based position index to a JSON number value. The integer is emitted as a JSON number.

Returns True for success, False for failure.

More Information and Examples
Modify Parts of JSON Document
top
SetIntOf
Function SetIntOf(jsonPath As String, value As Int32) As Boolean
Introduced in version 9.5.0.56

Sets the value at jsonPath to an integer JSON number.

Set vs. Update: Use UpdateInt when missing objects or array positions along the path should be created automatically.

Returns True for success, False for failure.

More Information and Examples
Modify Parts of JSON DocumentJSON Paths
top
SetNullAt
Function SetNullAt(index As Int32) As Boolean
Introduced in version 9.5.0.56

Sets the member at zero-based position index to a JSON null value.

Returns True for success, False for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
SetNullOf
Function SetNullOf(jsonPath As String) As Boolean
Introduced in version 9.5.0.56

Sets the value at jsonPath to a JSON null value.

Set vs. Update: Use UpdateNull when missing objects or array positions along the path should be created automatically.

Returns True for success, False for failure.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
SetNumberAt
Function SetNumberAt(index As Int32, value As String) As Boolean
Introduced in version 9.5.0.56

Sets the member at zero-based position index to a JSON number value. The value argument is the exact textual representation of the JSON number.

JSON number syntax: The text may contain an integer, fraction, or exponent. It must be valid JSON number syntax; leading zeros (except for zero itself), NaN, and infinity are not valid JSON numbers.

Returns True for success, False for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
SetNumberOf
Function SetNumberOf(jsonPath As String, value As String) As Boolean
Introduced in version 9.5.0.56

Sets the value at jsonPath to a JSON number value. The value argument supplies the exact textual form of the JSON number.

Set vs. Update: Use UpdateNumber when missing objects or array positions along the path should be created automatically.
Precision: Using numeric text avoids an intermediate conversion through a floating-point type and can therefore preserve large integers or application-specific decimal formatting.

Returns True for success, False for failure.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
SetStringAt
Function SetStringAt(index As Int32, value As String) As Boolean
Introduced in version 9.5.0.56

Sets the member at zero-based position index to a JSON string value. The string is escaped as required when JSON is emitted.

Returns True for success, False for failure.

More Information and Examples
Modify Parts of JSON Document
top
SetStringOf
Function SetStringOf(jsonPath As String, value As String) As Boolean
Introduced in version 9.5.0.56

Sets the value at jsonPath to a JSON string value. The string is escaped as required when JSON is emitted.

Set vs. Update: Use UpdateString when missing objects or array positions along the path should be created automatically.

Returns True for success, False for failure.

More Information and Examples
Modify Parts of JSON DocumentJSON Paths
top
SizeOfArray
Function SizeOfArray(jsonPath As String) As Int32
Introduced in version 9.5.0.56

Returns the number of elements in the JSON array at jsonPath. Returns -1 if the path does not resolve to an existing JSON array.

More Information and Examples
JSON Paths
top
Sort
Sub Sort(ascending As Boolean, caseSensitive As Boolean)
Introduced in version 9.5.0.100

Sorts this object's direct members by member name. ascending selects ascending or descending order, and caseSensitive controls how names are compared.

JSON semantics: Member ordering is not significant to JSON consumers, but sorting can make emitted JSON deterministic and easier to compare or review.
More Information and Examples
Sort JSON Object by Member Key Name
top
StringAt
Function StringAt(index As Int32) As String
Introduced in version 9.5.0.56

Returns the string value of the member at zero-based position index.

Indexing: Member indexes are based on the order maintained by this JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.
Non-string values: StringOf can also provide textual representations of scalar JSON values such as numbers, booleans, and null; use the type-specific methods when the JSON type itself matters.

Returns Nil on failure

More Information and Examples
JSON Iterate Members
top
StringOf
Function StringOf(jsonPath As String) As String
Introduced in version 9.5.0.56

Returns the value at jsonPath as text. For a JSON string, the string value is returned. Scalar non-string values such as numbers, booleans, and null are returned using their JSON textual representation.

Type-sensitive code: Use JsonTypeOf, IntOf, BoolOf, or IsNullOf when the distinction between JSON types is important.

Returns Nil on failure

More Information and Examples
JSON: Miscellaneous OperationsJSON PathsJSON Paths that need Double QuotesUsing JSON StringOf with Non-String Members
top
StringOfEquals
Function StringOfEquals(jsonPath As String, value As String, caseSensitive As Boolean) As Boolean
Introduced in version 9.5.0.96

Returns True if the textual value at jsonPath equals value according to the caseSensitive setting; otherwise returns False.

top
StringOfSb
Function StringOfSb(jsonPath As String, sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.68

Retrieves the value at jsonPath as text and appends it to sb.

Append behavior: Existing contents of the destination StringBuilder are preserved.

Returns True for success, False for failure.

top
Swap
Function Swap(index1 As Int32, index2 As Int32) As Boolean
Introduced in version 9.5.0.76

Swaps the positions of the direct members at zero-based indexes index1 and index2. Member names and values are unchanged.

Ordering: JSON object order is not semantically significant, but Chilkat preserves an order for index-based access and emission.

Returns True for success, False for failure.

More Information and Examples
Swap JSON Objects
top
TypeAt
Function TypeAt(index As Int32) As Int32
Introduced in version 9.5.0.58

Returns an integer identifying the JSON type of the member at zero-based position index. Returns -1 if no member exists at that index.

1string
2number
3object
4array
5boolean
6null
top
UIntOf
Function UIntOf(jsonPath As String) As UInt32
Introduced in version 9.5.0.96

Returns the unsigned integer value at jsonPath.

top
UpdateBd
Function UpdateBd(jsonPath As String, encoding As String, bd As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.68

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The bytes in bd are first encoded according to encoding (for example, base64 or hex) and the encoded text is stored as the JSON string value.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.
Binary data in JSON: JSON has no native byte-array type. Binary content must therefore be represented using a textual encoding agreed upon by the producer and consumer.

Returns True for success, False for failure.

More Information and Examples
Read/Write JSON with Binary Data such as JPEG Files
top
UpdateBool
Function UpdateBool(jsonPath As String, value As Boolean) As Boolean
Introduced in version 9.5.0.63

Updates the value at jsonPath to a JSON boolean value, or creates the member and any missing path components as needed.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

Returns True for success, False for failure.

top
UpdateInt
Function UpdateInt(jsonPath As String, value As Int32) As Boolean
Introduced in version 9.5.0.63

Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The integer value is stored as a JSON number.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

Returns True for success, False for failure.

More Information and Examples
JSON UpdateNumber vs UpdateInt
top
UpdateNewArray
Function UpdateNewArray(jsonPath As String) As Boolean
Introduced in version 9.5.0.75

Creates or replaces the value at jsonPath with a new empty JSON array. Missing path components are created automatically as needed.

Returns True for success, False for failure.

More Information and Examples
JSON Insert Empty Array or Object
top
UpdateNewObject
Function UpdateNewObject(jsonPath As String) As Boolean
Introduced in version 9.5.0.75

Creates or replaces the value at jsonPath with a new empty JSON object. Missing path components are created automatically as needed.

Returns True for success, False for failure.

More Information and Examples
JSON Insert Empty Array or Object
top
UpdateNull
Function UpdateNull(jsonPath As String) As Boolean
Introduced in version 9.5.0.65

Updates the value at jsonPath to a JSON null value, or creates the member and any missing path components as needed.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

Returns True for success, False for failure.

top
UpdateNumber
Function UpdateNumber(jsonPath As String, numericStr As String) As Boolean
Introduced in version 9.5.0.65

Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The numericStr argument is stored as the exact textual representation of the JSON number.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.
When to use: Use UpdateNumber instead of UpdateInt for decimal/exponent forms, very large integers, or when preserving exact numeric text is important.

Returns True for success, False for failure.

More Information and Examples
JSON UpdateNumber vs UpdateInt
top
UpdateSb
Function UpdateSb(jsonPath As String, sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.68

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The new string value is taken from the contents of sb.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

Returns True for success, False for failure.

top
UpdateString
Function UpdateString(jsonPath As String, value As String) As Boolean
Introduced in version 9.5.0.63

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The supplied string is JSON-escaped as needed.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.
Version note: Chilkat versions prior to 9.5.0.68 did not correctly escape all characters for this method. Version 9.5.0.68 and later correct that behavior.

Returns True for success, False for failure.

More Information and Examples
JSON UpdateString
top
UpdateUInt
Function UpdateUInt(jsonPath As String, value As UInt32) As Boolean
Introduced in version 9.5.0.96

Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The unsigned integer is stored as a JSON number.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

Returns True for success, False for failure.

top
WriteFile
Function WriteFile(path As String) As Boolean
Introduced in version 9.5.0.76

Serializes this JSON and writes it to the file at path. Output formatting follows EmitCompact and EmitCrLf.

Returns True for success, False for failure.

top

Deprecated

Clone
Function Clone() As Chilkat.JsonObject
Introduced in version 9.5.0.66
This method is deprecated and replaced by MakeCopy

Deprecated. Use MakeCopy instead. Returns an independent copy of this JSON object.

Returns Nil on failure

top