---
product: Chilkat
product_version: 11.7.0
language: xbase
language_label: Xbase++
class: HtmlToText
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xbase_HtmlToTextRef.html
---
# Chilkat HtmlToText — Xbase++ — v11.7.0

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

## Purpose

**Convert HTML into readable plain text with control over links, wrapping, and encoding.**

`Chilkat.HtmlToText` converts HTML content into readable plain text. It can decode HTML entities, wrap output at a configurable right margin, optionally include or suppress hyperlink URLs, convert HTML supplied as a string or `StringBuilder`, and read or write files using an explicit character encoding.

**HTML to plain text**

Convert HTML markup into readable text suitable for display, logging, indexing, email alternatives, or text-only output.

**Entity decoding**

Decode HTML entities so text such as named entities and numeric character references becomes normal readable output.

**Line wrapping**

Use `RightMargin` to wrap text at a chosen width, or set it to `0` when no right-margin wrapping is wanted.

**Link handling**

Suppress hyperlink URLs for cleaner text, or emit URLs when the output needs to preserve the destination of HTML links.

**StringBuilder support**

Convert HTML directly from a `StringBuilder` when working with larger or incrementally built HTML content.

**File and charset helpers**

Read HTML from files and write text output using a specified character encoding.

**Common pattern:** Provide the HTML as a string, file, or `StringBuilder`, choose whether to decode entities and include link URLs, set the desired right margin, then convert the result to plain text. Use `HtmlToText` when the goal is readable text, not structured XML or DOM-style parsing.

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

## Object creation, unlocking and error handling

**Object Creation**

```xbase
LOCAL oHtmlToText
oHtmlToText := CreateObject("Chilkat.HtmlToText")

// ... use oHtmlToText ...

oHtmlToText:destroy()
```

Xbase++ uses the Chilkat ActiveX through the automation object returned by `CreateObject()`; properties and methods are accessed with the send operator (`oHttp:ConnectTimeout := 30`, `oHttp:Download(cUrl, cPath)`), and `:destroy()` releases the object. Register the Chilkat ActiveX matching the bitness of your Xbase++ application. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `CreateObject("Chilkat.HtmlToText.11")` for Chilkat v11.\*.\*.

Boolean properties, arguments and return values are integers in the ActiveX: pass `1` or `0`, and test a method's success with `== 1`. A method that fails to return an object returns `NIL`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are automation objects too and should likewise be released with `:destroy()`. Methods and properties that pass or return raw byte arrays are not shown on this page; use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead.

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 Xbase++.

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` | `oHtmlToText:DebugLogFilePath // Character` | 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` | `oHtmlToText:LastErrorHtml // Character (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `oHtmlToText:LastErrorText // Character (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `oHtmlToText:LastErrorXml // Character (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `oHtmlToText:LastMethodSuccess // Numeric` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `oHtmlToText:LastStringResult // Character (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `oHtmlToText:LastStringResultLen // Numeric (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `oHtmlToText:VerboseLogging // Numeric` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `oHtmlToText:Version // Character (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `DecodeHtmlEntities` | property, read/write | `oHtmlToText:DecodeHtmlEntities // Numeric` |
| `RightMargin` | property, read/write | `oHtmlToText:RightMargin // Numeric` |
| `SuppressLinks` | property, read/write | `oHtmlToText:SuppressLinks // Numeric` |
| `UncommonOptions` | property, read/write | `oHtmlToText:UncommonOptions // Character` |
| `ToText` | method | `cResult := oHtmlToText:ToText(cHtml) // returns Character` |
| `ToTextSb` | method | `nSuccess := oHtmlToText:ToTextSb(oSb) // returns Numeric (1/0)` |

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

## Properties

### HtmlToText.DecodeHtmlEntities

`Chilkat 11.7.0 · xbase · HtmlToText · DecodeHtmlEntities · property · read/write`

```xbase
oHtmlToText:DecodeHtmlEntities  // Numeric
```

Controls whether HTML character references are decoded when converting HTML to plain text. The default value is `1`.

| Value | Behavior |
| :--- | :--- |
| `1` | HTML entities and numeric character references are decoded to their corresponding characters. For example, `&amp;` becomes `&`. |
| `0` | Character references are left encoded in the plain-text output. |

**Typical use:** Leave this property set to `1` when the goal is human-readable text. Set it to `0` when the original entity notation itself must be preserved.

### HtmlToText.RightMargin

`Chilkat 11.7.0 · xbase · HtmlToText · RightMargin · property · read/write`

```xbase
oHtmlToText:RightMargin  // Numeric
```

Controls line wrapping in the generated plain text. The default value is `80`. As a line approaches the configured margin, Chilkat attempts to wrap at a SPACE character. Set this property to `0` to disable right-margin wrapping.

**Soft margin:** The right margin is a preferred wrapping point, not a guaranteed maximum line length. A long sequence with no suitable SPACE character may extend beyond the configured margin.

### HtmlToText.SuppressLinks

`Chilkat 11.7.0 · xbase · HtmlToText · SuppressLinks · property · read/write`

```xbase
oHtmlToText:SuppressLinks  // Numeric
```

Controls whether hyperlink destination URLs are included in the generated plain text. The default value is `1`.

| Value | Behavior |
| :--- | :--- |
| `1` | The visible anchor text is retained, but hyperlink destination URLs are omitted. |
| `0` | Hyperlink URLs are included. By default, they are collected in a `References:` section at the end of the plain text. |

For example, with `SuppressLinks` set to `0`, an HTML link whose visible text is `chilkat` and whose URL is `https://www.chilkatsoft.com/` produces the visible text and a numbered reference at the end of the output.

**Related options:** When link URLs are enabled, `UncommonOptions` can be used to suppress the trailing references list with `NoReferencesList` or emit URLs inline with `EmitUrls`.

### HtmlToText.UncommonOptions

`Chilkat 11.7.0 · xbase · HtmlToText · UncommonOptions · property · read/write · since 11.0.0`

```xbase
oHtmlToText:UncommonOptions  // Character
```

Specifies uncommon HTML-to-text conversion options as a comma-separated list of keywords. The default is the empty string, which is appropriate for normal use.

| Keyword | Effect |
| :--- | :--- |
| `NoReferencesList` | Does not generate the hyperlink-reference list at the end of the plain-text output. |
| `EmitUrls` | Emits hyperlink URLs inline in the plain-text output instead of relying on the default trailing reference list. |

**Interaction with SuppressLinks:** These options control the presentation of hyperlink URLs when URL output is enabled. If `SuppressLinks` is `1`, hyperlink URLs are suppressed.

## Methods

### HtmlToText.ToText

`Chilkat 11.7.0 · xbase · HtmlToText · ToText · method`

```xbase
cResult := oHtmlToText:ToText(cHtml)  // returns Character
```

**Full documentation for this method (same in every language):** [HTML Tables to Plain Text Conversion Gallery](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/html_table_to_text.md)

Converts the HTML in `html` to readable plain text and returns the result. The conversion honors `DecodeHtmlEntities`, `RightMargin`, `SuppressLinks`, and `UncommonOptions`. HTML markup is interpreted to produce readable text rather than simply being removed with a tag-stripping operation.

**Plain-text conversion:** The output is intended for reading, indexing, logging, email text alternatives, and similar text-oriented uses. It is not intended to preserve the original HTML markup or visual layout exactly.

Returns `NIL` on failure

### HtmlToText.ToTextSb

`Chilkat 11.7.0 · xbase · HtmlToText · ToTextSb · method · since 9.5.0.97`

```xbase
nSuccess := oHtmlToText:ToTextSb(oSb)  // returns Numeric (1/0)
```

Converts the HTML currently contained in `sb` to plain text in place. On success, the same `StringBuilder` contains the converted plain-text result. The conversion honors `DecodeHtmlEntities`, `RightMargin`, `SuppressLinks`, and `UncommonOptions`.

**StringBuilder workflow:** Use this method when the HTML is already held in a `StringBuilder` and you want the conversion result returned through that same object rather than as a separate string.

Returns 1 for success, 0 for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `ReadFileToString` | method | before 11.6.1 | — |
| `WriteStringToFile` | method | before 11.6.1 | — |

## Related classes

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

