StringTable Dart Reference Documentation
CkStringTable
Current Version: 11.6.1
Chilkat.StringTable
Store a list of strings in insertion order and retrieve individual
entries by zero-based index.
Add strings directly, append strings from a file, or load line-delimited
text from a
Find entries containing a substring or matching a wildcard pattern when
filtering or locating text values.
Sort the string collection when deterministic ordering or user-facing
display order is needed.
Split delimited text into separate string-table entries for easier
indexing, searching, sorting, or saving.
Convert the table back to line-delimited text, copy it to a
For an extended overview, see
StringTable Class Overview.
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
Append and import
StringBuilder.
Search strings
Sort entries
Split into entries
Export and save
StringBuilder, or save the collection to a file.
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.
Object Creation
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final stringTable = CkStringTable();
// ... the native object is released when `stringTable` is garbage collected, or now with stringTable.dispose().Creates the underlying native Chilkat object. Use a CkStringTable only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: 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 exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
stringTable.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkStringTable.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
Count
int get count
The number of strings in the table.
topDebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
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.
LastErrorHtml
String get lastErrorHtml
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.
topLastErrorText
String get lastErrorText
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.
LastErrorXml
String get lastErrorXml
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.
topLastMethodSuccess
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
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.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
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
String get version
Methods
Append
Appends a string to the table.
Returns normally on success; throws a ChilkatException on failure.
AppendFromFile
Appends strings, one per line, from a file. Each line in the path should be no longer than the length specified in maxLineLen. The charset indicates the character encoding of the contents of the file, such as utf-8, iso-8859-1, Shift_JIS, etc.
Returns normally on success; throws a ChilkatException on failure.
AppendFromSb
Appends strings, one per line, from the contents of a StringBuilder object.
Returns normally on success; throws a ChilkatException on failure.
Clear
Removes all the strings from the table.
topFindMatch
This string table object holds strings with wildcards. The method returns the index of the wildcarded string that matches the text in sb, or -1 if no match is found. caseSensitive specifies whether the matching should be case-sensitive.
FindSubstring
Return the index of the first string in the table containing substr. Begins searching strings starting at startIndex. If caseSensitive is true, then the search is case sensitive. If caseSensitive is false then the search is case insensitive. Returns -1 if the substr is not found.
GetStrings
Return the number of strings specified by count, one per line, starting at startIdx. To return the entire table, pass 0 values for both startIdx and count. Set crlf equal to true to emit with CRLF line endings, or false to emit LF-only line endings. The last string is emitted includes the line ending.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
IntAt
Returns the Nth string in the table, converted to an integer value. The index is 0-based. (The first string is at index 0.) Returns -1 if no string is found at the specified index. Returns 0 if the string at the specified index exist, but is not an integer.
SaveToFile
Saves the string table to a file. The charset is the character encoding to use, such as utf-8, iso-8859-1, windows-1252, Shift_JIS, gb2312, etc. If bCrlf is true, then CRLF line endings are used, otherwise LF-only line endings are used.
Returns normally on success; throws a ChilkatException on failure.
Sort
Sorts the strings in the collection in ascending or descending order. To sort in ascending order, set ascending to true, otherwise set ascending equal to false.
Returns normally on success; throws a ChilkatException on failure.
SplitAndAppend
Splits a string into parts based on a single character delimiterChar. If exceptDoubleQuoted is true, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is true, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns normally on success; throws a ChilkatException on failure.
StringAt
Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
StringAtSb
Appends the Nth string in the table to sb. The index is 0-based. (The first string is at index 0.)
Returns normally on success; throws a ChilkatException on failure.
ToSb
Appends the entire string table to sb using CRLF line endings.
Returns normally on success; throws a ChilkatException on failure.
WordFollowing
The method performs a case-insensitive search to return the index of a table entry matching sb, or -1 if there is no match. Set captureEmailAddr to true if the target word is expected to be an email address, otherwise set captureEmailAddr to false. sbWord will receive the word (email address) following the matched text.
This method helps replace the outdated Chilkat Bounce class, which was used for identifying and categorizing bounced email types.