---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: HtmlToText
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_HtmlToTextRef.html
---
# Chilkat HtmlToText — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · 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/sqlserver/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**

```sql
DECLARE @hr int
DECLARE @htmlToText int
EXEC @hr = sp_OACreate 'Chilkat.HtmlToText', @htmlToText OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @htmlToText ...

EXEC @hr = sp_OADestroy @htmlToText
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.HtmlToText.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @htmlToText, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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` | `EXEC sp_OAGetProperty @htmlToText, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @htmlToText, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @htmlToText, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @htmlToText, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @htmlToText, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @htmlToText, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @htmlToText, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @htmlToText, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @htmlToText, 'LastStringResult', @sValue OUT` | 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` | `EXEC sp_OAGetProperty @htmlToText, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @htmlToText, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @htmlToText, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @htmlToText, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `DecodeHtmlEntities` | property, read/write | `EXEC sp_OAGetProperty @htmlToText, 'DecodeHtmlEntities', @iValue OUT EXEC sp_OASetProperty @htmlToText, 'DecodeHtmlEntities', @iValue` |
| `RightMargin` | property, read/write | `EXEC sp_OAGetProperty @htmlToText, 'RightMargin', @iValue OUT EXEC sp_OASetProperty @htmlToText, 'RightMargin', @iValue` |
| `SuppressLinks` | property, read/write | `EXEC sp_OAGetProperty @htmlToText, 'SuppressLinks', @iValue OUT EXEC sp_OASetProperty @htmlToText, 'SuppressLinks', @iValue` |
| `UncommonOptions` | property, read/write | `EXEC sp_OAGetProperty @htmlToText, 'UncommonOptions', @sValue OUT EXEC sp_OASetProperty @htmlToText, 'UncommonOptions', @sValue` |
| `ToText` | method | `EXEC sp_OAMethod @htmlToText, 'ToText', @sResult OUT, @html` |
| `ToTextSb` | method | `EXEC sp_OAMethod @htmlToText, 'ToTextSb', @success OUT, @sb` |

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 · sqlserver · HtmlToText · DecodeHtmlEntities · property · read/write`

```sql
EXEC sp_OAGetProperty @htmlToText, 'DecodeHtmlEntities', @iValue OUT
EXEC sp_OASetProperty @htmlToText, 'DecodeHtmlEntities', @iValue
```

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 · sqlserver · HtmlToText · RightMargin · property · read/write`

```sql
EXEC sp_OAGetProperty @htmlToText, 'RightMargin', @iValue OUT
EXEC sp_OASetProperty @htmlToText, 'RightMargin', @iValue
```

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 · sqlserver · HtmlToText · SuppressLinks · property · read/write`

```sql
EXEC sp_OAGetProperty @htmlToText, 'SuppressLinks', @iValue OUT
EXEC sp_OASetProperty @htmlToText, 'SuppressLinks', @iValue
```

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 · sqlserver · HtmlToText · UncommonOptions · property · read/write · since 11.0.0`

```sql
EXEC sp_OAGetProperty @htmlToText, 'UncommonOptions', @sValue OUT
EXEC sp_OASetProperty @htmlToText, 'UncommonOptions', @sValue
```

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 · sqlserver · HtmlToText · ToText · method`

```sql
EXEC sp_OAMethod @htmlToText, 'ToText', @sResult OUT, @html
```

**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 `NULL` on failure

### HtmlToText.ToTextSb

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

```sql
EXEC sp_OAMethod @htmlToText, 'ToTextSb', @success OUT, @sb
```

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/sqlserver/classes/StringBuilder.md)

