StringTable React Native Reference Documentation

StringTable

Current Version: 11.6.1

Chilkat.StringTable

Store, load, search, sort, split, retrieve, and save ordered lists of strings.

Chilkat.StringTable is a simple ordered collection of strings. It can append strings directly, load one string per line from files or StringBuilder, search for substrings or wildcard matches, sort the collection, split strings into entries, retrieve strings by index, export the table as line-delimited text, and save the result to a file.

Ordered string collection

Store a list of strings in insertion order and retrieve individual entries by zero-based index.

Append and import

Add strings directly, append strings from a file, or load line-delimited text from a StringBuilder.

Search strings

Find entries containing a substring or matching a wildcard pattern when filtering or locating text values.

Sort entries

Sort the string collection when deterministic ordering or user-facing display order is needed.

Split into entries

Split delimited text into separate string-table entries for easier indexing, searching, sorting, or saving.

Export and save

Convert the table back to line-delimited text, copy it to a StringBuilder, or save the collection to a file.

Common pattern: Use StringTable when application code needs a lightweight ordered list of text values. Append or load the strings, search or sort as needed, retrieve entries by index with StringAt or StringAtSb, then export the final list as line-delimited text or save it to a file.

For an extended overview, see StringTable Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, StringTable } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const stringTable = new StringTable()
// ... the native object is released when `stringTable` is garbage collected, or now with stringTable.dispose()

new StringTable()

Creates the underlying native Chilkat object. StringTable is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  stringTable.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // StringTable.someMethod(...): <reason>
  console.log(stringTable.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await stringTable.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // StringTable.someMethodAsync: <reason>
}

Properties

Count

// read-only
readonly count: number

Introduced in version 9.5.0.62

The number of strings in the table.

StringTable React Native Reference Documentation

StringTable

Current Version: 11.6.1

Store, load, search, sort, split, retrieve, and save ordered lists of strings.

Ordered string collection

Append and import

Search strings

Sort entries

Split into entries

Export and save

Object Creation

Errors

Properties

Count

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

VerboseLogging

Version

Methods

Append

AppendFromFile

AppendFromSb

Clear

FindMatch

FindSubstring

GetStrings

IntAt

SaveToFile

Sort

SplitAndAppend

StringAt

StringAtSb

ToSb

WordFollowing