CkHtmlToText Perl Reference Documentation

CkHtmlToText

Current Version: 10.1.0

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

$obj = chilkat::CkHtmlToText->new();

Properties

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$htmlToText->get_DebugLogFilePath($ckStr);
$strVal = $htmlToText->debugLogFilePath();
$htmlToText->put_DebugLogFilePath($strVal);

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

DecodeHtmlEntities

# $boolVal is a boolean
$boolVal = $htmlToText->get_DecodeHtmlEntities();
$htmlToText->put_DecodeHtmlEntities($boolVal);

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.

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$htmlToText->get_LastErrorHtml($ckStr);
$strVal = $htmlToText->lastErrorHtml();

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.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$htmlToText->get_LastErrorText($ckStr);
$strVal = $htmlToText->lastErrorText();

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$htmlToText->get_LastErrorXml($ckStr);
$strVal = $htmlToText->lastErrorXml();

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.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $htmlToText->get_LastMethodSuccess();
$htmlToText->put_LastMethodSuccess($boolVal);

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.

RightMargin

# $intVal is an integer
$intVal = $htmlToText->get_RightMargin();
$htmlToText->put_RightMargin($intVal);

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

# $boolVal is a boolean
$boolVal = $htmlToText->get_SuppressLinks();
$htmlToText->put_SuppressLinks($boolVal);

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.

Utf8

# $boolVal is a boolean
$boolVal = $htmlToText->get_Utf8();
$htmlToText->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging

# $boolVal is a boolean
$boolVal = $htmlToText->get_VerboseLogging();
$htmlToText->put_VerboseLogging($boolVal);

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

# $strVal is a string
# $ckStr is a CkString
$htmlToText->get_Version($ckStr);
$strVal = $htmlToText->version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

ReadFileToString

# $filename is a string
# $srcCharset is a string
# $outStr is a CkString (output)
$status = $htmlToText->ReadFileToString($filename, $srcCharset, $outStr);
$retStr = $htmlToText->readFileToString($filename, $srcCharset);

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 1 for success, 0 for failure.

More Information and Examples

Convert HTML to Plain Text

ToText

# $html is a string
# $outStr is a CkString (output)
$status = $htmlToText->ToText($html, $outStr);
$retStr = $htmlToText->toText($html);

Converts HTML to plain-text.

Returns 1 for success, 0 for failure.

More Information and Examples

Convert HTML to Plain Text

ToTextSb

# $sb is a CkStringBuilder
$status = $htmlToText->ToTextSb($sb);

Introduced in version 9.5.0.97

Converts the HTML in sb to plain-text.

Returns 1 for success, 0 for failure.

WriteStringToFile

# $stringToWrite is a string
# $filename is a string
# $charset is a string
$status = $htmlToText->WriteStringToFile($stringToWrite, $filename, $charset);

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.