HtmlToText PureBasic Reference Documentation

HtmlToText

Current Version: 9.5.0.75

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

obj.i = CkHtmlToText::ckCreate()

; Make sure to dispose of the object when finished like this:
CkHtmlToText::ckDispose(obj);

Properties

DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DecodeHtmlEntities
Declare.i ckDecodeHtmlEntities(obj.i)
Declare setCkDecodeHtmlEntities(obj.i, value.i)

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.

top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
Declare.s ckLastErrorText(obj.i) ; (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
Declare.s ckLastErrorXml(obj.i) ; (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
RightMargin
Declare.i ckRightMargin(obj.i)
Declare setCkRightMargin(obj.i, value.i)

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.

top
SuppressLinks
Declare.i ckSuppressLinks(obj.i)
Declare setCkSuppressLinks(obj.i, value.i)

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

<p><p>Test <a href="http://www.chilkatsoft.com/">chilkat</a></p>
converts to:
Test chilkat <http://www.chilkatsoft.com/>
If this property is 0, the above HTML would convert to:
Test chilkat
The default value of this property is 1.

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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.

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

top

Methods

IsUnlocked
Declare.i ckIsUnlocked(obj.i)

Returns 1 if the component is already unlocked. Otherwise returns 0.

top
ReadFileToString
Declare.s ckReadFileToString(obj.i, filename.s, srcCharset.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
SaveLastError
Declare.i ckSaveLastError(obj.i, path.s)

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
ToText
Declare.s ckToText(obj.i, html.s)

Converts HTML to plain-text.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top
UnlockComponent
Declare.i ckUnlockComponent(obj.i, code.s)

Unlocks the component. An arbitrary unlock code may be passed to automatically begin a 30-day trial.

This class is included with the Chilkat HTML-to-XML conversion component license.

Returns 1 for success, 0 for failure.

top
WriteStringToFile
Declare.i ckWriteStringToFile(obj.i, stringToWrite.s, filename.s, charset.s)

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.

top