---
product: Chilkat
product_version: 11.7.0
language: js
language_label: JavaScript
class: StringTable
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/jsStringTableRef.html
---
# Chilkat StringTable — JavaScript — v11.7.0

> Chilkat 11.7.0 · language=js · class=StringTable
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/StringTable.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/guide.md`.

## Purpose

**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](https://www.chilkatsoft.com/stringtable_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkStringTable();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in JavaScript.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Count` | property, read-only | `Count` |
| `Append` | method | `var success = Append(value);` |
| `AppendFromFile` | method | `var success = AppendFromFile(maxLineLen, charset, path);` |
| `AppendFromSb` | method | `var success = AppendFromSb(sb);` |
| `Clear` | method | `Clear();` |
| `FindMatch` | method | `var intVal = FindMatch(sb, caseSensitive);` |
| `FindSubstring` | method | `var intVal = FindSubstring(startIndex, substr, caseSensitive);` |
| `GetStrings` | method | `var strVal = GetStrings(startIdx, count, crlf);` |
| `IntAt` | method | `var intVal = IntAt(index);` |
| `SaveToFile` | method | `var success = SaveToFile(charset, bCrlf, path);` |
| `Sort` | method | `var success = Sort(ascending, caseSensitive);` |
| `SplitAndAppend` | method | `var success = SplitAndAppend(inStr, delimiterChar, exceptDoubleQuoted, exceptEscaped);` |
| `StringAt` | method | `var strVal = StringAt(index);` |
| `StringAtSb` | method | `var success = StringAtSb(index, sb);` |
| `ToSb` | method | `var success = ToSb(sb);` |
| `WordFollowing` | method | `var intVal = WordFollowing(sb, captureEmailAddr, sbWord);` |

## Properties

### StringTable.Count

`Chilkat 11.7.0 · js · StringTable · Count · property · read-only · since 9.5.0.62`

```javascript
Count
```

· `int`, `read-only`

The number of strings in the table.

## Methods

### StringTable.Append

`Chilkat 11.7.0 · js · StringTable · Append · method · since 9.5.0.62`

```javascript
var success = Append(value);
```

· return: `boolean`; `true` for success, `false` for failure  
· value: `string`

Appends a string to the table.

Returns true for success, false for failure.

### StringTable.AppendFromFile

`Chilkat 11.7.0 · js · StringTable · AppendFromFile · method · since 9.5.0.62`

```javascript
var success = AppendFromFile(maxLineLen, charset, path);
```

· return: `boolean`; `true` for success, `false` for failure  
· maxLineLen: `int`  
· charset: `string`  
· path: `string`

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 true for success, false for failure.

### StringTable.AppendFromSb

`Chilkat 11.7.0 · js · StringTable · AppendFromSb · method · since 9.5.0.62`

```javascript
var success = AppendFromSb(sb);
```

· return: `boolean`; `true` for success, `false` for failure  
· sb: `CkStringBuilder`

Appends strings, one per line, from the contents of a StringBuilder object.

Returns true for success, false for failure.

### StringTable.Clear

`Chilkat 11.7.0 · js · StringTable · Clear · method · since 9.5.0.62`

```javascript
Clear();
```

· return: `undefined`

Removes all the strings from the table.

### StringTable.FindMatch

`Chilkat 11.7.0 · js · StringTable · FindMatch · method · since 11.1.0`

```javascript
var intVal = FindMatch(sb, caseSensitive);
```

· return: `int`  
· sb: `CkStringBuilder`  
· caseSensitive: `boolean`

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.

### StringTable.FindSubstring

`Chilkat 11.7.0 · js · StringTable · FindSubstring · method · since 9.5.0.77`

```javascript
var intVal = FindSubstring(startIndex, substr, caseSensitive);
```

· return: `int`  
· startIndex: `int`  
· substr: `string`  
· caseSensitive: `boolean`

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.

### StringTable.GetStrings

`Chilkat 11.7.0 · js · StringTable · GetStrings · method · since 9.5.0.87`

```javascript
var strVal = GetStrings(startIdx, count, crlf);
```

· return: `string`  
· startIdx: `int`  
· count: `int`  
· crlf: `boolean`

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.

Returns `null` on failure

### StringTable.IntAt

`Chilkat 11.7.0 · js · StringTable · IntAt · method · since 9.5.0.63`

```javascript
var intVal = IntAt(index);
```

· return: `int`  
· index: `int`

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.

### StringTable.SaveToFile

`Chilkat 11.7.0 · js · StringTable · SaveToFile · method · since 9.5.0.62`

```javascript
var success = SaveToFile(charset, bCrlf, path);
```

· return: `boolean`; `true` for success, `false` for failure  
· charset: `string`  
· bCrlf: `boolean`  
· path: `string`

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 true for success, false for failure.

### StringTable.Sort

`Chilkat 11.7.0 · js · StringTable · Sort · method · since 9.5.0.87`

```javascript
var success = Sort(ascending, caseSensitive);
```

· return: `boolean`; `true` for success, `false` for failure  
· ascending: `boolean`  
· caseSensitive: `boolean`

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 true for success, false for failure.

### StringTable.SplitAndAppend

`Chilkat 11.7.0 · js · StringTable · SplitAndAppend · method · since 9.5.0.62`

```javascript
var success = SplitAndAppend(inStr, delimiterChar, exceptDoubleQuoted, exceptEscaped);
```

· return: `boolean`; `true` for success, `false` for failure  
· inStr: `string`  
· delimiterChar: `string`  
· exceptDoubleQuoted: `boolean`  
· exceptEscaped: `boolean`

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 true for success, false for failure.

### StringTable.StringAt

`Chilkat 11.7.0 · js · StringTable · StringAt · method · since 9.5.0.62`

```javascript
var strVal = StringAt(index);
```

· return: `string`  
· index: `int`

Returns the Nth string in the table. The `index` is 0-based. (The first string is at index 0.)

Returns `null` on failure

### StringTable.StringAtSb

`Chilkat 11.7.0 · js · StringTable · StringAtSb · method · since 11.2.0`

```javascript
var success = StringAtSb(index, sb);
```

· return: `boolean`; `true` for success, `false` for failure  
· index: `int`  
· sb: `CkStringBuilder`

Appends the Nth string in the table to `sb`. The `index` is 0-based. (The first string is at index 0.)

Returns true for success, false for failure.

### StringTable.ToSb

`Chilkat 11.7.0 · js · StringTable · ToSb · method · since 11.3.0`

```javascript
var success = ToSb(sb);
```

· return: `boolean`; `true` for success, `false` for failure  
· sb: `CkStringBuilder`

Appends the entire string table to `sb` using CRLF line endings.

Returns true for success, false for failure.

### StringTable.WordFollowing

`Chilkat 11.7.0 · js · StringTable · WordFollowing · method · since 11.1.0`

```javascript
var intVal = WordFollowing(sb, captureEmailAddr, sbWord);
```

· return: `int`  
· sb: `CkStringBuilder`  
· captureEmailAddr: `boolean`  
· sbWord: `CkStringBuilder`

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.

## Related classes

[`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/js/classes/StringBuilder.md)