HtmlToText ActiveX Reference Documentation

HtmlToText

Current Version: 10.1.2

Requires Chilkat Bundle License

HTML to plain-text conversion component. The internal conversion process is much more sophisticated than can be accomplished with the simple regular-expression freeware codes found in the Internet. This is more than simply removing HTML tags from an HTML document.

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.HtmlToText" instead of "Chilkat.HtmlToText"
For a specific major version, use "Chilkat.HtmlToText.<major_version>", such as "Chilkat.HtmlToText.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.HtmlToText")

(AutoIt)
$obj = ObjCreate("Chilkat.HtmlToText")

(Visual Basic 6.0)
Dim obj As New HtmlToText

(VBScript)
set obj = CreateObject("Chilkat.HtmlToText")

(Delphi)
obj := THtmlToText.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.HtmlToText')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.HtmlToText")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.HtmlToText', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.HtmlToText");

Properties

DebugLogFilePath

DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.

DecodeHtmlEntities

DecodeHtmlEntities As Long

If 1, then HTML entities are automatically decoded. For example & is automatically decoded to &. If this property is set to 0, then HTML entities are not decoded. The default value is 1.

LastBinaryResult

LastBinaryResult As Variant (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. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

RightMargin

RightMargin As Long

Used to control wrapping of text. The default value is 80. When the text gets close to this margin, the converter will try to break the line at a SPACE character. Set this property to 0 for no right margin.

SuppressLinks

SuppressLinks As Long

If 0, then link URL's are preserved inline. For example, the following HTML fragment:

<p><p>Test <a href="https://www.chilkatsoft.com/">chilkat</a></p>

converts to:

Test chilkat <https://www.chilkatsoft.com/>

If this property is 1, the above HTML would convert to:

Test chilkat

The default value of this property is 1.

VerboseLogging

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version As String (read-only)

Version of the component/library, such as "10.1.0"

More Information and Examples

(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.

Methods

ReadFileToString

ReadFileToString(filename As String, srcCharset As String) As String

Convenience method for reading a text file into a string. The character encoding of the text file is specified by srcCharset. Valid values, such as "iso-8895-1" or "utf-8" are listed at: List of Charsets.

Returns Nothing on failure

More Information and Examples

(AutoIt) Convert HTML to Plain Text (Classic ASP) Convert HTML to Plain Text (PowerBuilder) Convert HTML to Plain Text (SQL Server) Convert HTML to Plain Text (VBScript) Convert HTML to Plain Text (Visual Basic 6.0) Convert HTML to Plain Text (Visual FoxPro) Convert HTML to Plain Text

ToText

ToText(html As String) As String

Converts HTML to plain-text.

Returns Nothing on failure

More Information and Examples

(AutoIt) Convert HTML to Plain Text (Classic ASP) Convert HTML to Plain Text (PowerBuilder) Convert HTML to Plain Text (SQL Server) Convert HTML to Plain Text (VBScript) Convert HTML to Plain Text (Visual Basic 6.0) Convert HTML to Plain Text (Visual FoxPro) Convert HTML to Plain Text

ToTextSb

ToTextSb(sb As ChilkatStringBuilder) As Long

Introduced in version 9.5.0.97

Converts the HTML in sb to plain-text.

Returns 1 for success, 0 for failure.

WriteStringToFile

WriteStringToFile(stringToWrite As String, filename As String, charset As String) As Long

Convenience method for saving a string to a file. The character encoding of the output text file is specified by charset (the string is converted to this charset when writing). Valid values, such as "iso-8895-1" or "utf-8" are listed at: List of Charsets.

Returns 1 for success, 0 for failure.