---
product: Chilkat
product_version: 11.7.0
language: ckpython
language_label: CkPython
class: StringBuilder
class_name: CkStringBuilder
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/pythonCkStringBuilderRef.html
---
# Chilkat StringBuilder — CkPython — v11.7.0

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

## Purpose

**Build, transform, search, encode, decode, hash, and save mutable text.**

`Chilkat.StringBuilder` is a flexible mutable text container for constructing and transforming strings. It supports appending text, integers, random values, UUIDs, encoded bytes, and `BinData`; searching, comparing, extracting, replacing, masking, regex processing, line-ending normalization, encoding, decoding, hashing, Markdown conversion, file I/O, and secure clearing of sensitive text.

**Build text incrementally**

Append strings, characters, integers, random values, UUIDs, encoded data, and other Chilkat objects without repeatedly recreating strings.

**Search and extract**

Find substrings, compare content, extract ranges, split or inspect text, and work with selected portions of the buffer.

**Replace and transform**

Replace text, mask sensitive values, normalize line endings, trim or edit content, and apply regex-based processing when needed.

**Encoding and decoding**

Encode or decode text and binary data using formats such as Base64, hex, URL encoding, quoted-printable, and other supported encodings.

**Hashing and conversion**

Compute hashes of the current text, convert Markdown to HTML, and move content between `StringBuilder`, `BinData`, files, and plain strings.

**File I/O and secure clearing**

Load text from files, save text with explicit character encodings, and securely clear the buffer when it contains sensitive data.

**Common pattern:** Use `StringBuilder` when text will be assembled or modified in multiple steps. Append or load the starting content, perform searches, replacements, encoding, decoding, hashing, or line-ending normalization, then retrieve the result as a string, save it to a file, or pass the object directly to another Chilkat method.

For an extended overview, see [StringBuilder Class Overview](https://www.chilkatsoft.com/stringbuilder_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```python
obj = chilkat.CkStringBuilder()
```

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

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` | `# strVal is a string # ckStr is a CkString stringBuilder.get_DebugLogFilePath(ckStr); strVal = stringBuilder.debugLogFilePath(); stringBuilder.put_DebugLogFilePath(strVal);` | 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` | `# strVal is a string # ckStr is a CkString stringBuilder.get_LastErrorHtml(ckStr); strVal = stringBuilder.lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `# strVal is a string # ckStr is a CkString stringBuilder.get_LastErrorText(ckStr); strVal = stringBuilder.lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `# strVal is a string # ckStr is a CkString stringBuilder.get_LastErrorXml(ckStr); strVal = stringBuilder.lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `# boolVal is a boolean boolVal = stringBuilder.get_LastMethodSuccess(); stringBuilder.put_LastMethodSuccess(boolVal);` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `Utf8` | `# boolVal is a boolean boolVal = stringBuilder.get_Utf8(); stringBuilder.put_Utf8(boolVal);` | read/write | When set to `True`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `# boolVal is a boolean boolVal = stringBuilder.get_VerboseLogging(); stringBuilder.put_VerboseLogging(boolVal);` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `# strVal is a string # ckStr is a CkString stringBuilder.get_Version(ckStr); strVal = stringBuilder.version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `HasEmojis` | property, read-only | `# boolVal is a boolean boolVal = stringBuilder.get_HasEmojis();` |
| `IntValue` | property, read/write | `# intVal is an integer intVal = stringBuilder.get_IntValue(); stringBuilder.put_IntValue(intVal);` |
| `IsBase64` | property, read-only | `# boolVal is a boolean boolVal = stringBuilder.get_IsBase64();` |
| `Length` | property, read-only | `# intVal is an integer intVal = stringBuilder.get_Length();` |
| `Append` | method | `# value is a string status = stringBuilder.Append(value);` |
| `AppendBd` | method | `# binData is a CkBinData # charset is a string # offset is an integer # numBytes is an integer status = stringBuilder.AppendBd(binData, charset, offset, numBytes);` |
| `AppendInt` | method | `# value is an integer status = stringBuilder.AppendInt(value);` |
| `AppendInt64` | method | `# value is a 64-bit integer status = stringBuilder.AppendInt64(value);` |
| `AppendLine` | method | `# str is a string # crlf is a boolean status = stringBuilder.AppendLine(str, crlf);` |
| `AppendLn` | method | `# str is a string status = stringBuilder.AppendLn(str);` |
| `AppendRandom` | method | `# numBytes is an integer # encoding is a string status = stringBuilder.AppendRandom(numBytes, encoding);` |
| `AppendSb` | method | `# sb is a CkStringBuilder status = stringBuilder.AppendSb(sb);` |
| `AppendUuid` | method | `# lowerCase is a boolean status = stringBuilder.AppendUuid(lowerCase);` |
| `AppendUuid7` | method | `# lowerCase is a boolean status = stringBuilder.AppendUuid7(lowerCase);` |
| `Clear` | method | `stringBuilder.Clear();` |
| `Contains` | method | `# str is a string # caseSensitive is a boolean retBool = stringBuilder.Contains(str, caseSensitive);` |
| `ContainsWord` | method | `# word is a string # caseSensitive is a boolean retBool = stringBuilder.ContainsWord(word, caseSensitive);` |
| `ContentsEqual` | method | `# str is a string # caseSensitive is a boolean retBool = stringBuilder.ContentsEqual(str, caseSensitive);` |
| `ContentsEqualSb` | method | `# sb is a CkStringBuilder # caseSensitive is a boolean retBool = stringBuilder.ContentsEqualSb(sb, caseSensitive);` |
| `Decode` | method | `# encoding is a string # charset is a string status = stringBuilder.Decode(encoding, charset);` |
| `DecodeAndAppend` | method | `# value is a string # encoding is a string # charset is a string status = stringBuilder.DecodeAndAppend(value, encoding, charset);` |
| `Encode` | method | `# encoding is a string # charset is a string status = stringBuilder.Encode(encoding, charset);` |
| `EndsWith` | method | `# substr is a string # caseSensitive is a boolean retBool = stringBuilder.EndsWith(substr, caseSensitive);` |
| `EntityDecode` | method | `status = stringBuilder.EntityDecode();` |
| `GetAfterBetween` | method | `# searchAfter is a string # beginMark is a string # endMark is a string # outStr is a CkString (output) status = stringBuilder.GetAfterBetween(searchAfter, beginMark, endMark, outStr); retStr = stringBuilder.getAfterBetween(searchAfter, beginMark, endMark);` |
| `GetAfterFinal` | method | `# marker is a string # removeFlag is a boolean # outStr is a CkString (output) status = stringBuilder.GetAfterFinal(marker, removeFlag, outStr); retStr = stringBuilder.getAfterFinal(marker, removeFlag);` |
| `GetAsString` | method | `# outStr is a CkString (output) status = stringBuilder.GetAsString(outStr); retStr = stringBuilder.getAsString();` |
| `GetBefore` | method | `# marker is a string # removeFlag is a boolean # outStr is a CkString (output) status = stringBuilder.GetBefore(marker, removeFlag, outStr); retStr = stringBuilder.getBefore(marker, removeFlag);` |
| `GetBetween` | method | `# beginMark is a string # endMark is a string # outStr is a CkString (output) status = stringBuilder.GetBetween(beginMark, endMark, outStr); retStr = stringBuilder.getBetween(beginMark, endMark);` |
| `GetEncoded` | method | `# encoding is a string # charset is a string # outStr is a CkString (output) status = stringBuilder.GetEncoded(encoding, charset, outStr); retStr = stringBuilder.getEncoded(encoding, charset);` |
| `GetHash` | method | `# algorithm is a string # encoding is a string # charset is a string # outStr is a CkString (output) status = stringBuilder.GetHash(algorithm, encoding, charset, outStr); retStr = stringBuilder.getHash(algorithm, encoding, charset);` |
| `GetNth` | method | `# index is an integer # delimiterChar is a string # exceptDoubleQuoted is a boolean # exceptEscaped is a boolean # outStr is a CkString (output) status = stringBuilder.GetNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped, outStr); retStr = stringBuilder.getNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped);` |
| `GetRange` | method | `# startIndex is an integer # numChars is an integer # removeFlag is a boolean # outStr is a CkString (output) status = stringBuilder.GetRange(startIndex, numChars, removeFlag, outStr); retStr = stringBuilder.getRange(startIndex, numChars, removeFlag);` |
| `GetRangeSb` | method | `# startIndex is an integer # numChars is an integer # removeFlag is a boolean # sb is a CkStringBuilder status = stringBuilder.GetRangeSb(startIndex, numChars, removeFlag, sb);` |
| `HtmlToMarkdown` | method | `status = stringBuilder.HtmlToMarkdown();` |
| `IsWellFormed` | method | `# format is a string retBool = stringBuilder.IsWellFormed(format);` |
| `LastNLines` | method | `# numLines is an integer # bCrlf is a boolean # outStr is a CkString (output) status = stringBuilder.LastNLines(numLines, bCrlf, outStr); retStr = stringBuilder.lastNLines(numLines, bCrlf);` |
| `LoadFile` | method | `# path is a string # charset is a string status = stringBuilder.LoadFile(path, charset);` |
| `MarkdownToHtml` | method | `# options is a CkJsonObject # sbHtml is a CkStringBuilder status = stringBuilder.MarkdownToHtml(options, sbHtml);` |
| `MaskQuotedStrings` | method | `# maskChar is a string # quoteType is an integer # maskedStrings is a CkStringTable status = stringBuilder.MaskQuotedStrings(maskChar, quoteType, maskedStrings);` |
| `Obfuscate` | method | `stringBuilder.Obfuscate();` |
| `Prepend` | method | `# value is a string status = stringBuilder.Prepend(value);` |
| `PunyDecode` | method | `status = stringBuilder.PunyDecode();` |
| `PunyEncode` | method | `status = stringBuilder.PunyEncode();` |
| `RegexMatch` | method | `# pattern is a string # json is a CkJsonObject # timeoutMs is an integer retInt = stringBuilder.RegexMatch(pattern, json, timeoutMs);` |
| `RegexReplace` | method | `# json is a CkJsonObject status = stringBuilder.RegexReplace(json);` |
| `RemoveAccents` | method | `status = stringBuilder.RemoveAccents();` |
| `RemoveAfterFinal` | method | `# marker is a string status = stringBuilder.RemoveAfterFinal(marker);` |
| `RemoveBefore` | method | `# marker is a string status = stringBuilder.RemoveBefore(marker);` |
| `RemoveCharsAt` | method | `# startIndex is an integer # numChars is an integer status = stringBuilder.RemoveCharsAt(startIndex, numChars);` |
| `RemoveEmojis` | method | `stringBuilder.RemoveEmojis();` |
| `Replace` | method | `# value is a string # replacement is a string retInt = stringBuilder.Replace(value, replacement);` |
| `ReplaceAfterFinal` | method | `# marker is a string # replacement is a string status = stringBuilder.ReplaceAfterFinal(marker, replacement);` |
| `ReplaceAllBetween` | method | `# beginMark is a string # endMark is a string # replacement is a string # replaceMarks is a boolean status = stringBuilder.ReplaceAllBetween(beginMark, endMark, replacement, replaceMarks);` |
| `ReplaceBetween` | method | `# beginMark is a string # endMark is a string # value is a string # replacement is a string retInt = stringBuilder.ReplaceBetween(beginMark, endMark, value, replacement);` |
| `ReplaceFirst` | method | `# value is a string # replacement is a string status = stringBuilder.ReplaceFirst(value, replacement);` |
| `ReplaceI` | method | `# value is a string # replacement is an integer retInt = stringBuilder.ReplaceI(value, replacement);` |
| `ReplaceNoCase` | method | `# value is a string # replacement is a string retInt = stringBuilder.ReplaceNoCase(value, replacement);` |
| `ReplaceWord` | method | `# value is a string # replacement is a string retInt = stringBuilder.ReplaceWord(value, replacement);` |
| `RestoreMaskedStrings` | method | `# quoteType is an integer # maskedStrings is a CkStringTable status = stringBuilder.RestoreMaskedStrings(quoteType, maskedStrings);` |
| `SecureClear` | method | `stringBuilder.SecureClear();` |
| `SetNth` | method | `# index is an integer # value is a string # delimiterChar is a string # exceptDoubleQuoted is a boolean # exceptEscaped is a boolean status = stringBuilder.SetNth(index, value, delimiterChar, exceptDoubleQuoted, exceptEscaped);` |
| `SetString` | method | `# value is a string status = stringBuilder.SetString(value);` |
| `Shorten` | method | `# numChars is an integer status = stringBuilder.Shorten(numChars);` |
| `StartsWith` | method | `# substr is a string # caseSensitive is a boolean retBool = stringBuilder.StartsWith(substr, caseSensitive);` |
| `ToCRLF` | method | `status = stringBuilder.ToCRLF();` |
| `ToLF` | method | `status = stringBuilder.ToLF();` |
| `ToLowercase` | method | `status = stringBuilder.ToLowercase();` |
| `ToUppercase` | method | `status = stringBuilder.ToUppercase();` |
| `Trim` | method | `status = stringBuilder.Trim();` |
| `TrimInsideSpaces` | method | `status = stringBuilder.TrimInsideSpaces();` |
| `Unobfuscate` | method | `stringBuilder.Unobfuscate();` |
| `WriteFile` | method | `# path is a string # charset is a string # emitBom is a boolean status = stringBuilder.WriteFile(path, charset, emitBom);` |
| `WriteFileIfModified` | method | `# path is a string # charset is a string # emitBom is a boolean status = stringBuilder.WriteFileIfModified(path, charset, emitBom);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### StringBuilder.HasEmojis

`Chilkat 11.7.0 · ckpython · StringBuilder · HasEmojis · property · read-only · since 11.1.0`

```python
# boolVal is a boolean

boolVal = stringBuilder.get_HasEmojis();
```

Returns `True` if the content contains one or more emoji characters.

### StringBuilder.IntValue

`Chilkat 11.7.0 · ckpython · StringBuilder · IntValue · property · read/write · since 9.5.0.58`

```python
# intVal is an integer

intVal = stringBuilder.get_IntValue();

stringBuilder.put_IntValue(intVal);
```

Returns the content of the string converted to an integer.

### StringBuilder.IsBase64

`Chilkat 11.7.0 · ckpython · StringBuilder · IsBase64 · property · read-only · since 9.5.0.76`

```python
# boolVal is a boolean

boolVal = stringBuilder.get_IsBase64();
```

Returns `True` if the content contains only those characters allowed in the base64 encoding. A base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is ignored.

### StringBuilder.Length

`Chilkat 11.7.0 · ckpython · StringBuilder · Length · property · read-only · since 9.5.0.58`

```python
# intVal is an integer

intVal = stringBuilder.get_Length();
```

The number of characters of the string contained within this instance.

## Methods

### StringBuilder.Append

`Chilkat 11.7.0 · ckpython · StringBuilder · Append · method · since 9.5.0.58`

```python
# value is a string

status = stringBuilder.Append(value);
```

Appends a copy of the specified string to this instance.

Returns True for success, False for failure.

### StringBuilder.AppendBd

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendBd · method · since 9.5.0.64`

```python
# binData is a CkBinData

# charset is a string

# offset is an integer

# numBytes is an integer

status = stringBuilder.AppendBd(binData, charset, offset, numBytes);
```

Appends the contents of `binData`. The `charset` specifies the character encoding of the bytes contained in `binData`. The `charset` can be any of the supported encodings listed at [Chilkat Supported Character Encodings](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp). To append the entire contents of `binData`, set `offset` and `numBytes` equal to zero. To append a range of `binData`, set the `offset` and `numBytes` to specify the range.

Returns True for success, False for failure.

### StringBuilder.AppendInt

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendInt · method · since 9.5.0.58`

```python
# value is an integer

status = stringBuilder.AppendInt(value);
```

Appends the string representation of a specified 32-bit signed integer to this instance.

Returns True for success, False for failure.

### StringBuilder.AppendInt64

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendInt64 · method · since 9.5.0.58`

```python
# value is a 64-bit integer

status = stringBuilder.AppendInt64(value);
```

Appends the string representation of a specified 64-bit signed integer to this instance.

Returns True for success, False for failure.

### StringBuilder.AppendLine

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendLine · method · since 9.5.0.65`

```python
# str is a string

# crlf is a boolean

status = stringBuilder.AppendLine(str, crlf);
```

Appends the `str` followed by a CRLF or LF to the end of the curent StringBuilder object. If `crlf` is `True`, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns True for success, False for failure.

### StringBuilder.AppendLn

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendLn · method · since 11.5.0`

```python
# str is a string

status = stringBuilder.AppendLn(str);
```

Appends the `str` followed by a CRLF to the end of this object. This method is the same as `AppendLine` , except the line-ending is always CRLF.

Returns True for success, False for failure.

### StringBuilder.AppendRandom

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendRandom · method · since 9.5.0.96`

```python
# numBytes is an integer

# encoding is a string

status = stringBuilder.AppendRandom(numBytes, encoding);
```

Append `numBytes` random bytes encoded according to `encoding`. `encoding` can be `hex`, `hex_lower`, `base64`, `base64url`, or any other encoding supported by Chilkat.

Returns True for success, False for failure.

### StringBuilder.AppendSb

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendSb · method · since 9.5.0.62`

```python
# sb is a CkStringBuilder

status = stringBuilder.AppendSb(sb);
```

Appends the contents of another StringBuilder to this instance.

Returns True for success, False for failure.

### StringBuilder.AppendUuid

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendUuid · method · since 9.5.0.93`

```python
# lowerCase is a boolean

status = stringBuilder.AppendUuid(lowerCase);
```

Generates and appends a random GUID/UUID such as 63c35f38-2b5f-4600-b3da-3ddee86d62b3. If `lowerCase` is `True`, then the hex values use lowercase (`a` - `f`). If `lowerCase` is `False` then uppercase is used (`A` - `F`).

Note: This generates a version 4 UUID.

Returns True for success, False for failure.

### StringBuilder.AppendUuid7

`Chilkat 11.7.0 · ckpython · StringBuilder · AppendUuid7 · method · since 10.1.0`

```python
# lowerCase is a boolean

status = stringBuilder.AppendUuid7(lowerCase);
```

Generates and appends a random version 7 UUID. If `lowerCase` is `True`, then the hex values use lowercase (`a` - `f`). If `lowerCase` is `False` then uppercase is used (`A` - `F`).

Returns True for success, False for failure.

### StringBuilder.Clear

`Chilkat 11.7.0 · ckpython · StringBuilder · Clear · method · since 9.5.0.58`

```python
stringBuilder.Clear();
```

Removes all characters from the current StringBuilder instance.

### StringBuilder.Contains

`Chilkat 11.7.0 · ckpython · StringBuilder · Contains · method · since 9.5.0.58`

```python
# str is a string

# caseSensitive is a boolean

retBool = stringBuilder.Contains(str, caseSensitive);
```

Returns `True` if the `str` is contained within this object. For case sensitive matching, set `caseSensitive` equal to `True`. For case-insensitive, set `caseSensitive` equal to `False`.

### StringBuilder.ContainsWord

`Chilkat 11.7.0 · ckpython · StringBuilder · ContainsWord · method · since 9.5.0.69`

```python
# word is a string

# caseSensitive is a boolean

retBool = stringBuilder.ContainsWord(word, caseSensitive);
```

Returns `True` if the `word` is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

For case sensitive matching, set `caseSensitive` equal to `True`. For case-insensitive, set `caseSensitive` equal to `False`.

### StringBuilder.ContentsEqual

`Chilkat 11.7.0 · ckpython · StringBuilder · ContentsEqual · method · since 9.5.0.62`

```python
# str is a string

# caseSensitive is a boolean

retBool = stringBuilder.ContentsEqual(str, caseSensitive);
```

Returns `True` if the contents of this object equals the `str`. Returns `False` if unequal. For case insensitive equality, set `caseSensitive` equal to `False`.

### StringBuilder.ContentsEqualSb

`Chilkat 11.7.0 · ckpython · StringBuilder · ContentsEqualSb · method · since 9.5.0.62`

```python
# sb is a CkStringBuilder

# caseSensitive is a boolean

retBool = stringBuilder.ContentsEqualSb(sb, caseSensitive);
```

Returns `True` if the contents of this object equals the `sb`. Returns `False` if unequal. For case insensitive equality, set `caseSensitive` equal to `False`.

### StringBuilder.Decode

`Chilkat 11.7.0 · ckpython · StringBuilder · Decode · method · since 9.5.0.62`

```python
# encoding is a string

# charset is a string

status = stringBuilder.Decode(encoding, charset);
```

Decodes and replaces the contents with the decoded string. The `encoding` can be set to any of the following strings: `base64`, `hex`, `quoted-printable` (or `qp`), `url`, `base32`, `Q`, `B`, `url_rc1738`, `url_rfc2396`, `url_rfc3986`, `url_oauth`, `uu`, `modBase64`, or `html` (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled `Supported Binary Encodings` below.

Note: This method can only be called if the encoded content decodes to a string. The `charset` indicates the charset to be used in intepreting the decoded bytes. For example, the `charset` can be `utf-8`, `utf-16`, `iso-8859-1`, `shift_JIS`, etc.

Returns True for success, False for failure.

### StringBuilder.DecodeAndAppend

`Chilkat 11.7.0 · ckpython · StringBuilder · DecodeAndAppend · method · since 9.5.0.87`

```python
# value is a string

# encoding is a string

# charset is a string

status = stringBuilder.DecodeAndAppend(value, encoding, charset);
```

Decodes a binary encoded string, where the binary encoding (such as `url`, `hex`, `base64`, etc.) is specified by `encoding`, and the underlying charset encoding (such as `utf-8`, `windows-1252`, etc.) is specified by `charset`. The decoded string is appended to this object.

Returns True for success, False for failure.

### StringBuilder.Encode

`Chilkat 11.7.0 · ckpython · StringBuilder · Encode · method · since 9.5.0.62`

```python
# encoding is a string

# charset is a string

status = stringBuilder.Encode(encoding, charset);
```

**Full documentation for this method (same in every language):** [Supported Binary Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Encodes to base64, hex, quoted-printable, URL encoding, etc. The `encoding` can be set to any of the following strings: `base64`, `hex`, `quoted-printable` (or `qp`), `url`, `base32`, `Q`, `B`, `url_rc1738`, `url_rfc2396`, `url_rfc3986`, `url_oauth`, `uu`, `modBase64`, or `html` (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled `Supported Binary Encodings` below.

Returns True for success, False for failure.

### StringBuilder.EndsWith

`Chilkat 11.7.0 · ckpython · StringBuilder · EndsWith · method · since 9.5.0.62`

```python
# substr is a string

# caseSensitive is a boolean

retBool = stringBuilder.EndsWith(substr, caseSensitive);
```

Returns `True` if the string ends with `substr`. Otherwise returns `False`. The comparison is case sensitive if `caseSensitive` is `True`, and case insensitive if `caseSensitive` is `False`.

### StringBuilder.EntityDecode

`Chilkat 11.7.0 · ckpython · StringBuilder · EntityDecode · method · since 9.5.0.62`

```python
status = stringBuilder.EntityDecode();
```

Decodes HTML entities. See [HTML entities](https://duckduckgo.com/?q=html+entities&bext=wfp&ia=web) for more information about HTML entities.

Returns True for success, False for failure.

### StringBuilder.GetAfterBetween

`Chilkat 11.7.0 · ckpython · StringBuilder · GetAfterBetween · method · since 9.5.0.62`

```python
# searchAfter is a string

# beginMark is a string

# endMark is a string

# outStr is a CkString (output)

status = stringBuilder.GetAfterBetween(searchAfter, beginMark, endMark, outStr);

retStr = stringBuilder.getAfterBetween(searchAfter, beginMark, endMark);
```

Begin searching after the 1st occurrence of `searchAfter` is found, and then return the substring found between the next occurrence of `beginMark` and the next occurrence of `endMark`.

Returns True for success, False for failure.

### StringBuilder.GetAfterFinal

`Chilkat 11.7.0 · ckpython · StringBuilder · GetAfterFinal · method · since 9.5.0.77`

```python
# marker is a string

# removeFlag is a boolean

# outStr is a CkString (output)

status = stringBuilder.GetAfterFinal(marker, removeFlag, outStr);

retStr = stringBuilder.getAfterFinal(marker, removeFlag);
```

Returns the substring found after the final occurrence of `marker`. If `removeFlag` is `True`, the `marker` and the content that follows is removed from this content.

If the `marker` is not present, then the entire string is returned. In this case, if `removeFlag` is `True`, this object is also cleared.

Returns True for success, False for failure.

### StringBuilder.GetAsString

`Chilkat 11.7.0 · ckpython · StringBuilder · GetAsString · method · since 9.5.0.58`

```python
# outStr is a CkString (output)

status = stringBuilder.GetAsString(outStr);

retStr = stringBuilder.getAsString();
```

Returns the contents as a string.

Returns True for success, False for failure.

### StringBuilder.GetBefore

`Chilkat 11.7.0 · ckpython · StringBuilder · GetBefore · method · since 9.5.0.77`

```python
# marker is a string

# removeFlag is a boolean

# outStr is a CkString (output)

status = stringBuilder.GetBefore(marker, removeFlag, outStr);

retStr = stringBuilder.getBefore(marker, removeFlag);
```

Returns the substring found before the 1st occurrence of `marker`. If `removeFlag` is `True`, the content up to and including the `marker` is removed from this object's contents.

If the `marker` is not present, then the entire string is returned. In this case, if `removeFlag` is `True`, this object is also cleared.

Returns True for success, False for failure.

### StringBuilder.GetBetween

`Chilkat 11.7.0 · ckpython · StringBuilder · GetBetween · method · since 9.5.0.62`

```python
# beginMark is a string

# endMark is a string

# outStr is a CkString (output)

status = stringBuilder.GetBetween(beginMark, endMark, outStr);

retStr = stringBuilder.getBetween(beginMark, endMark);
```

Returns the substring found between the 1st occurrence of `beginMark` and the next occurrence of `endMark`.

Returns True for success, False for failure.

### StringBuilder.GetEncoded

`Chilkat 11.7.0 · ckpython · StringBuilder · GetEncoded · method · since 9.5.0.62`

```python
# encoding is a string

# charset is a string

# outStr is a CkString (output)

status = stringBuilder.GetEncoded(encoding, charset, outStr);

retStr = stringBuilder.getEncoded(encoding, charset);
```

**Full documentation for this method (same in every language):** [Supported Binary Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The `encoding` can be set to any of the following strings: `base64`, `hex`, `quoted-printable` (or `qp`), `url`, `base32`, `Q`, `B`, `url_rc1738`, `url_rfc2396`, `url_rfc3986`, `url_oauth`, `uu`, `modBase64`, or `html` (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled `Supported Binary Encodings` below.

Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.

Returns True for success, False for failure.

### StringBuilder.GetHash

`Chilkat 11.7.0 · ckpython · StringBuilder · GetHash · method · since 9.5.0.91`

```python
# algorithm is a string

# encoding is a string

# charset is a string

# outStr is a CkString (output)

status = stringBuilder.GetHash(algorithm, encoding, charset, outStr);

retStr = stringBuilder.getHash(algorithm, encoding, charset);
```

Returns the hash of the contents of this object. The `algorithm` is the hash algorithm, and can be `sha1`, `sha256`, `sha384`, `sha512`, `sha3-224`, `sha3-256`, `sha3-384`, `sha3-512`, `md2`, `md5`, `ripemd128`, `ripemd160`,`ripemd256`, or `ripemd320`. The `encoding` can be `base64`, `modBase64`, `base64Url`, `base32`, `base58`, `qp` (for quoted-printable), `url` (for url-encoding), `hex`, `hexLower`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

The `charset` is the character encoding byte representation to hash. It is typically `utf-8`. It can be any of the chacter encodings listed at [Chilkat Character Encodings List](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).

Returns True for success, False for failure.

### StringBuilder.GetNth

`Chilkat 11.7.0 · ckpython · StringBuilder · GetNth · method · since 9.5.0.62`

```python
# index is an integer

# delimiterChar is a string

# exceptDoubleQuoted is a boolean

# exceptEscaped is a boolean

# outStr is a CkString (output)

status = stringBuilder.GetNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped, outStr);

retStr = stringBuilder.getNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped);
```

Returns the Nth substring in string that is a list delimted by `delimiterChar`. The first substring is at index 0. 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.

### StringBuilder.GetRange

`Chilkat 11.7.0 · ckpython · StringBuilder · GetRange · method · since 9.5.0.87`

```python
# startIndex is an integer

# numChars is an integer

# removeFlag is a boolean

# outStr is a CkString (output)

status = stringBuilder.GetRange(startIndex, numChars, removeFlag, outStr);

retStr = stringBuilder.getRange(startIndex, numChars, removeFlag);
```

Returns a string containing the specified range of characters from this instance. If `removeFlag` is `True`, then the range of chars is removed from this instance.

Note: It was discovered that the range of chars was always removed regardless of the value of `removeFlag`. This is fixed in v9.5.0.89.

Returns True for success, False for failure.

### StringBuilder.GetRangeSb

`Chilkat 11.7.0 · ckpython · StringBuilder · GetRangeSb · method · since 11.3.0`

```python
# startIndex is an integer

# numChars is an integer

# removeFlag is a boolean

# sb is a CkStringBuilder

status = stringBuilder.GetRangeSb(startIndex, numChars, removeFlag, sb);
```

Appends to `startIndex` the specified range of characters from this instance. If `removeFlag` is `True`, then the range of chars is removed from this instance.

Returns True for success, False for failure.

### StringBuilder.HtmlToMarkdown

`Chilkat 11.7.0 · ckpython · StringBuilder · HtmlToMarkdown · method · since 11.7.0`

```python
status = stringBuilder.HtmlToMarkdown();
```

Converts the HTML contained in this object to Markdown, replacing the contents with the Markdown. Returns `True` on success. If the conversion fails, the contents are left unchanged and the reason is in the LastErrorText.

This is the reverse of `MarkdownToHtml`. The HTML is parsed with the same parser used by `Html.ToXml` and `Html.ToText`, and the resulting document tree produces CommonMark / GitHub-flavored Markdown:

- `h1` through `h6` become `#` .. `######` headings.
- `p`, `div`, `section` and other block-level elements become paragraphs separated by a blank line. `br` becomes a hard line break and `hr` becomes `---`.
- `b`/`strong` become `**bold**`, `i`/`em`/`cite` become `*italic*`, `del`/`s`/`strike` become `~~struck~~`, and `code`/`kbd`/`samp` become a backtick code span.
- `pre` becomes a fenced code block. The language is taken from a `language-xxx` or `lang-xxx` class on the `pre` or its `code` child.
- `a href` becomes `[text](url "title")`, and `img` becomes `![alt](src "title")`.
- `ul`/`ol`/`li` become `-` and `1.` lists, with nested lists indented. A checkbox `input` inside a list item becomes `[ ]` or `[x]`.
- `blockquote` becomes lines prefixed with `>`.
- `table` becomes a GitHub pipe table. The first row is the header when it contains `th` cells or is inside a `thead`; `colspan` is honored, and `align` or `text-align` sets the column alignment. A single-column table becomes plain paragraphs, because such tables are usually for layout.
- `dl`/`dt`/`dd` become a term line followed by `: definition` lines.

`head`, `script`, `style`, `title`, `meta`, `link`, `noscript`, `iframe`, `object`, `embed`, `svg`, `canvas`, form controls and comments produce no output. Any other tag is transparent: only its content is emitted.

Markdown-significant punctuation in ordinary text is backslash-escaped so that the text renders literally. Text inside `code` and `pre` is never escaped. HTML entities are decoded.

The Markdown uses LF line endings, always ends with a single line ending, and never contains more than one consecutive blank line outside of a code block. Call `ToCRLF` afterwards for CRLF line endings.

**Note:** The conversion is in-place. The HTML is not available after a successful call, so load it into a separate `StringBuilder` first if it is still needed.

Empty contents, or HTML with no visible content, produce empty contents and `True` is returned.

Returns True for success, False for failure.

### StringBuilder.IsWellFormed

`Chilkat 11.7.0 · ckpython · StringBuilder · IsWellFormed · method · since 11.6.0`

```python
# format is a string

retBool = stringBuilder.IsWellFormed(format);
```

Returns `True` if the contents of this object are well-formed JSON or XML. `format` selects which check to apply and must be `json` or `xml` (case insensitive). Returns `False` if the contents do not conform, or if `format` is anything else.

Chilkat's JSON and XML parsers are deliberately tolerant. Given text that is not well-formed they can still report success, leaving an empty or partially populated document. This method answers the question those parsers do not, and it does so without loading the text into a `JsonObject` or `Xml` object first. The checks applied here are the same ones those classes apply when their `Strict` property is set.

For `xml` this is a **well-formedness** check: element nesting and tag matching, attribute syntax and duplicate attributes, entity and character references, comments, processing instructions, CDATA sections, the XML declaration, the DOCTYPE declaration, and that the bytes are valid UTF-8 containing only characters XML permits. It is not a validating parse: no DTD or schema is read.

For `json` the full RFC 8259 grammar is checked.

Empty contents are not well-formed in either format, so `False` is returned.

**Note:** The contents of this object are never modified by this method.

### StringBuilder.LastNLines

`Chilkat 11.7.0 · ckpython · StringBuilder · LastNLines · method · since 9.5.0.62`

```python
# numLines is an integer

# bCrlf is a boolean

# outStr is a CkString (output)

status = stringBuilder.LastNLines(numLines, bCrlf, outStr);

retStr = stringBuilder.lastNLines(numLines, bCrlf);
```

Returns the last N lines of the text. If fewer than `numLines` lines exists, then all of the text is returned. If `bCrlf` is `True`, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns True for success, False for failure.

### StringBuilder.LoadFile

`Chilkat 11.7.0 · ckpython · StringBuilder · LoadFile · method · since 9.5.0.62`

```python
# path is a string

# charset is a string

status = stringBuilder.LoadFile(path, charset);
```

Loads the contents of a file.

Returns True for success, False for failure.

### StringBuilder.MarkdownToHtml

`Chilkat 11.7.0 · ckpython · StringBuilder · MarkdownToHtml · method · since 11.2.0`

```python
# options is a CkJsonObject

# sbHtml is a CkStringBuilder

status = stringBuilder.MarkdownToHtml(options, sbHtml);
```

This method converts the Markdown content of this object to HTML, storing the result in `sbHtml`. It supports both streaming and full document conversion. `options` specifies conversion options, including a key `streaming` option. In `streaming` mode, generated HTML is appended to `sbHtml`. In non-streaming mode, `sbHtml` is fully replaced by the generated HTML. For further details, see the examples linked below.

In `streaming` mode, only complete markdown lines are converted to HTML and removed from this object, leaving just the final partial line, if present. If this object contains only a partial markdown line, no HTML is emitted.

---

Starting in `v11.3.0` ...

- `"emitJavascript": true` can be included in `options` to emit Javascript function calls instead of HTML. This is used to update the response in an embedded browser in real-time. See [Real-Time Streaming AI Responses to Embedded Browsers in Desktop Apps](https://www.chilkatsoft.com/ai_real_time_ui_streaming.asp)
- `"streamingShell": true` is used to convert an empty string to an HTML shell to be used as the starting point before applying Javascript function calls. See [Preparing the HTML Shell](https://www.chilkatsoft.com/preparing_the_html_shell.asp)

- `"theme": "html_theme_name"` can be included when creating the HTML shell to select a predefined theme or when converting Markdown to HTML in non-streaming mode. The available themes are:
  - ChatGPT - A style that is similar to the ChatGPT application.
  - cleanWin - A clean style for Windows applications.
  - cleanMac - A clean style for MacOS applications.
  - raw - No HTML styles, header, or body begin/end elements are emitted. Only the Markdown to HTML generated elements are emitted.

  If no `theme` is is included, then default HTML docType/root/body/header elements are emitted unless various parts are overridden by `docType`, `rootElement`, `head`, `bodyStart`, `bodyEnd`, and `bodyExtra`.

- `"usesPrism": true` can be included when creating the HTML shell (or when converting Markdown to HTML in non-streaming mode) to include [PRISM code highlighting](https://prismjs.com/).

- `"prism": { "theme": "prism_theme_name" }` Is optional and can be used to specify the prism theme when `usesPrism` is `true`. Possible values are:
  - tomorrow
  - default
  - coy
  - dark
  - funky
  - okaidia
  - solarizedlight
  - twilight

- `"prism": { "version": "version_number" }` Is optional can can be used to specify the prism version, such as `"1.29.0"` when `usesPrism` is `true`. If not specified, then "1.29.0" is used.

- If no `theme` is specified, then any or all of the following HTML document parts can be explicitly specified:
  - `"docType": "doctype_element"` The `DOCTYPE` element. The default is `"<!DOCTYPE html>"`
  - `"rootElement": "root_element"` The `html` element. The default is `"<html>"`
  - `"head": "head_section"` The HTML fragment for the HTML head section. The default is `"<head><meta charset="utf-8" /></head>"`.  
    Note: If `usesPrism` is `true`, then prism related links will be inserted just before the `</head>`.
  - `"bodyStart": "html_fragment"` The HTML fragment to begin the body section. The default is `"<body><div id="content">"`
  - `"bodyEnd": "html_fragment"` The HTML fragment to end the body section. The default is `"</div><!-- end-of-content-div --></body>"`
  - `"noContentDiv": true` If set, the default bodyStart and bodyEnd do not include the `"<div id="content">"` and `"</div><!-- end-of-content-div -->"`

- `"copyButton": true` In non-streaming mode, can optionally be set to include HTML for adding a copy button. THe copy button is added by default in streaming mode.

- `"ChatGPT": { "max-width": "css_length"; }` Is optional can can be used to specify the max width of the body text if the `theme` is `ChatGPT`. The css_length is a length using CSS length units, such as `"72ch"`, `"40em"`, `"800px"`, etc.

Returns True for success, False for failure.

### StringBuilder.MaskQuotedStrings

`Chilkat 11.7.0 · ckpython · StringBuilder · MaskQuotedStrings · method · since 11.2.0`

```python
# maskChar is a string

# quoteType is an integer

# maskedStrings is a CkStringTable

status = stringBuilder.MaskQuotedStrings(maskChar, quoteType, maskedStrings);
```

This function masks the content inside single and/or double-quoted strings by replacing it with a specified mask character (`maskChar`). The content of each masked quoted string is saved to `maskedStrings`. The contents can be restored by calling RestoreMaskedStrings.

`quoteType` determines which types of quoted strings are masked:

0. Both single and double quoted.
1. Only single quoted strings.
2. Only double quoted strings.

Returns True for success, False for failure.

### StringBuilder.Obfuscate

`Chilkat 11.7.0 · ckpython · StringBuilder · Obfuscate · method · since 9.5.0.80`

```python
stringBuilder.Obfuscate();
```

Obfuscates the string. (The Unobfuscate method can be called to reverse the obfuscation to restore the original string.)

The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is NOT a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.

### StringBuilder.Prepend

`Chilkat 11.7.0 · ckpython · StringBuilder · Prepend · method · since 9.5.0.61`

```python
# value is a string

status = stringBuilder.Prepend(value);
```

Prepends a copy of the specified string to this instance.

Returns True for success, False for failure.

### StringBuilder.PunyDecode

`Chilkat 11.7.0 · ckpython · StringBuilder · PunyDecode · method · since 9.5.0.71`

```python
status = stringBuilder.PunyDecode();
```

In-place decodes the string from punycode.

Returns True for success, False for failure.

### StringBuilder.PunyEncode

`Chilkat 11.7.0 · ckpython · StringBuilder · PunyEncode · method · since 9.5.0.71`

```python
status = stringBuilder.PunyEncode();
```

In-place encodes the string to punycode.

Returns True for success, False for failure.

### StringBuilder.RegexMatch

`Chilkat 11.7.0 · ckpython · StringBuilder · RegexMatch · method · since 11.1.0`

```python
# pattern is a string

# json is a CkJsonObject

# timeoutMs is an integer

retInt = stringBuilder.RegexMatch(pattern, json, timeoutMs);
```

**Full documentation for this method (same in every language):** [Chilkat Uses PCRE2 (Perl Compatible Regular Expressions, version 2)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2.md) · [Chilkat PCRE2 Performance](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2_performance.md)

Searches the content of this object for substrings that match a regular expression pattern and returns the matches in `json`. Returns the number of matches or -1 for failure. `timeoutMs` is the maximum number of milliseconds of processing allowed before giving up. Pass 0 for an infinite amount of time. Failure information is also returned in `json`.

### StringBuilder.RegexReplace

`Chilkat 11.7.0 · ckpython · StringBuilder · RegexReplace · method · since 11.1.0`

```python
# json is a CkJsonObject

status = stringBuilder.RegexReplace(json);
```

**Full documentation for this method (same in every language):** [Chilkat Uses PCRE2 (Perl Compatible Regular Expressions, version 2)](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2.md) · [Chilkat PCRE2 Performance](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/chilkat_pcre2_performance.md)

Replaces the substrings of capture groups found in a previous call to RegexMatch.

Returns True for success, False for failure.

### StringBuilder.RemoveAccents

`Chilkat 11.7.0 · ckpython · StringBuilder · RemoveAccents · method · since 9.5.0.91`

```python
status = stringBuilder.RemoveAccents();
```

Removes the accents (diacritics) from European accented characters. This applies only to the accented characters found in the Windows-1252 (Latin alphabet) and Windows-1250 (Central European) charsets. Accent marks for characters in other languages will not be removed.

Returns True for success, False for failure.

### StringBuilder.RemoveAfterFinal

`Chilkat 11.7.0 · ckpython · StringBuilder · RemoveAfterFinal · method · since 9.5.0.77`

```python
# marker is a string

status = stringBuilder.RemoveAfterFinal(marker);
```

Removes the substring found after the final occurrence of the `marker`. Also removes the `marker`. Returns `True` if the `marker` was found and content was removed. Otherwise returns `False`.

Returns True for success, False for failure.

### StringBuilder.RemoveBefore

`Chilkat 11.7.0 · ckpython · StringBuilder · RemoveBefore · method · since 9.5.0.77`

```python
# marker is a string

status = stringBuilder.RemoveBefore(marker);
```

Removes the substring found before the 1st occurrence of the `marker`. Also removes the `marker`. Returns `True` if the `marker` was found and content was removed. Otherwise returns `False`.

Returns True for success, False for failure.

### StringBuilder.RemoveCharsAt

`Chilkat 11.7.0 · ckpython · StringBuilder · RemoveCharsAt · method · since 9.5.0.87`

```python
# startIndex is an integer

# numChars is an integer

status = stringBuilder.RemoveCharsAt(startIndex, numChars);
```

Removes the specified range of characters from this instance.

Returns True for success, False for failure.

### StringBuilder.RemoveEmojis

`Chilkat 11.7.0 · ckpython · StringBuilder · RemoveEmojis · method · since 11.1.0`

```python
stringBuilder.RemoveEmojis();
```

Removes all emoji characters from the string.

### StringBuilder.Replace

`Chilkat 11.7.0 · ckpython · StringBuilder · Replace · method · since 9.5.0.58`

```python
# value is a string

# replacement is a string

retInt = stringBuilder.Replace(value, replacement);
```

Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.

### StringBuilder.ReplaceAfterFinal

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceAfterFinal · method · since 9.5.0.73`

```python
# marker is a string

# replacement is a string

status = stringBuilder.ReplaceAfterFinal(marker, replacement);
```

Replaces the content found after the final occurrence of `marker` with `replacement`.

Returns True for success, False for failure.

### StringBuilder.ReplaceAllBetween

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceAllBetween · method · since 9.5.0.64`

```python
# beginMark is a string

# endMark is a string

# replacement is a string

# replaceMarks is a boolean

status = stringBuilder.ReplaceAllBetween(beginMark, endMark, replacement, replaceMarks);
```

Replaces the first occurrence of ALL the content found between `beginMark` and `endMark` with `replacement`. The `beginMark` and `endMark` are included in what is replaced if `replaceMarks` is `True`.

Returns True for success, False for failure.

### StringBuilder.ReplaceBetween

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceBetween · method · since 9.5.0.62`

```python
# beginMark is a string

# endMark is a string

# value is a string

# replacement is a string

retInt = stringBuilder.ReplaceBetween(beginMark, endMark, value, replacement);
```

Replaces all occurrences of `value` with `replacement`, but only where `value` is found between `beginMark` and `endMark`. Returns the number of replacements made.

### StringBuilder.ReplaceFirst

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceFirst · method · since 9.5.0.77`

```python
# value is a string

# replacement is a string

status = stringBuilder.ReplaceFirst(value, replacement);
```

Replaces the first occurrence of a specified string in this instance with another string. Returns `True` if the `value` was found and replaced. Otherwise returns `False`.

Returns True for success, False for failure.

### StringBuilder.ReplaceI

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceI · method · since 9.5.0.67`

```python
# value is a string

# replacement is an integer

retInt = stringBuilder.ReplaceI(value, replacement);
```

Replaces all occurrences of `value` with the decimal integer `replacement`. Returns the number of replacements.

### StringBuilder.ReplaceNoCase

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceNoCase · method · since 9.5.0.82`

```python
# value is a string

# replacement is a string

retInt = stringBuilder.ReplaceNoCase(value, replacement);
```

Replaces all occurrences of `value` with `replacement` (case insensitive). Returns the number of replacements.

### StringBuilder.ReplaceWord

`Chilkat 11.7.0 · ckpython · StringBuilder · ReplaceWord · method · since 9.5.0.62`

```python
# value is a string

# replacement is a string

retInt = stringBuilder.ReplaceWord(value, replacement);
```

Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.

Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

### StringBuilder.RestoreMaskedStrings

`Chilkat 11.7.0 · ckpython · StringBuilder · RestoreMaskedStrings · method · since 11.2.0`

```python
# quoteType is an integer

# maskedStrings is a CkStringTable

status = stringBuilder.RestoreMaskedStrings(quoteType, maskedStrings);
```

Restores single and/or double-quoted strings previously masked by MaskQuotedStrings.

`quoteType` determines which types of quoted strings are masked:

0. Both single and double quoted.
1. Only single quoted strings.
2. Only double quoted strings.

Returns True for success, False for failure.

### StringBuilder.SecureClear

`Chilkat 11.7.0 · ckpython · StringBuilder · SecureClear · method · since 9.5.0.67`

```python
stringBuilder.SecureClear();
```

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

### StringBuilder.SetNth

`Chilkat 11.7.0 · ckpython · StringBuilder · SetNth · method · since 9.5.0.62`

```python
# index is an integer

# value is a string

# delimiterChar is a string

# exceptDoubleQuoted is a boolean

# exceptEscaped is a boolean

status = stringBuilder.SetNth(index, value, delimiterChar, exceptDoubleQuoted, exceptEscaped);
```

Sets the Nth substring in string in a list delimted by `delimiterChar`. The first substring is at index 0. 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.

### StringBuilder.SetString

`Chilkat 11.7.0 · ckpython · StringBuilder · SetString · method · since 9.5.0.61`

```python
# value is a string

status = stringBuilder.SetString(value);
```

Sets this instance to a copy of the specified string.

Returns True for success, False for failure.

### StringBuilder.Shorten

`Chilkat 11.7.0 · ckpython · StringBuilder · Shorten · method · since 9.5.0.87`

```python
# numChars is an integer

status = stringBuilder.Shorten(numChars);
```

Shortens the string by removing the last `numChars` chars.

Returns True for success, False for failure.

### StringBuilder.StartsWith

`Chilkat 11.7.0 · ckpython · StringBuilder · StartsWith · method · since 9.5.0.62`

```python
# substr is a string

# caseSensitive is a boolean

retBool = stringBuilder.StartsWith(substr, caseSensitive);
```

Returns `True` if the string starts with `substr`. Otherwise returns `False`. The comparison is case sensitive if `caseSensitive` is `True`, and case insensitive if `caseSensitive` is `False`.

### StringBuilder.ToCRLF

`Chilkat 11.7.0 · ckpython · StringBuilder · ToCRLF · method · since 9.5.0.62`

```python
status = stringBuilder.ToCRLF();
```

Converts line endings to CRLF (Windows) format.

Returns True for success, False for failure.

### StringBuilder.ToLF

`Chilkat 11.7.0 · ckpython · StringBuilder · ToLF · method · since 9.5.0.62`

```python
status = stringBuilder.ToLF();
```

Converts line endings to LF-only (UNIX) format.

Returns True for success, False for failure.

### StringBuilder.ToLowercase

`Chilkat 11.7.0 · ckpython · StringBuilder · ToLowercase · method · since 9.5.0.62`

```python
status = stringBuilder.ToLowercase();
```

Converts the contents to lowercase.

Returns True for success, False for failure.

### StringBuilder.ToUppercase

`Chilkat 11.7.0 · ckpython · StringBuilder · ToUppercase · method · since 9.5.0.62`

```python
status = stringBuilder.ToUppercase();
```

Converts the contents to uppercase.

Returns True for success, False for failure.

### StringBuilder.Trim

`Chilkat 11.7.0 · ckpython · StringBuilder · Trim · method · since 9.5.0.62`

```python
status = stringBuilder.Trim();
```

Trims whitespace from both ends of the string.

Returns True for success, False for failure.

### StringBuilder.TrimInsideSpaces

`Chilkat 11.7.0 · ckpython · StringBuilder · TrimInsideSpaces · method · since 9.5.0.62`

```python
status = stringBuilder.TrimInsideSpaces();
```

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

Returns True for success, False for failure.

### StringBuilder.Unobfuscate

`Chilkat 11.7.0 · ckpython · StringBuilder · Unobfuscate · method · since 9.5.0.80`

```python
stringBuilder.Unobfuscate();
```

Unobfuscates the string.

The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.

### StringBuilder.WriteFile

`Chilkat 11.7.0 · ckpython · StringBuilder · WriteFile · method · since 9.5.0.62`

```python
# path is a string

# charset is a string

# emitBom is a boolean

status = stringBuilder.WriteFile(path, charset, emitBom);
```

Writes the contents to a file. If `emitBom` is `True`, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns True for success, False for failure.

### StringBuilder.WriteFileIfModified

`Chilkat 11.7.0 · ckpython · StringBuilder · WriteFileIfModified · method · since 9.5.0.73`

```python
# path is a string

# charset is a string

# emitBom is a boolean

status = stringBuilder.WriteFileIfModified(path, charset, emitBom);
```

Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file. If `emitBom` is `True`, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns True for success, False for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `AppendEncoded` | method | before 11.6.1 | — |
| `GetDecoded` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckpython/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckpython/classes/JsonObject.md), [`StringTable`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/ckpython/classes/StringTable.md)