HtmlToText Unicode C++ Reference Documentation

CkHtmlToTextW

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

// Local variable on the stack
CkHtmlToTextW obj;

// Dynamically allocate/delete
CkHtmlToTextW *pObj = new CkHtmlToTextW();
// ...
delete pObj;

Properties

DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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
Example showing how to use DebugLogFilePath.
top
DecodeHtmlEntities
bool get_DecodeHtmlEntities(void);
void put_DecodeHtmlEntities(bool newVal);

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

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

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.

top
LastErrorText
void get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

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 LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

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.

top
LastMethodSuccess
bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Indicates the success or failure of the most recent method call: true means success, false 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.

top
RightMargin
int get_RightMargin(void);
void put_RightMargin(int newVal);

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.

top
SuppressLinks
bool get_SuppressLinks(void);
void put_SuppressLinks(bool newVal);

If false, 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 true, the above HTML would convert to: 
Test chilkat
The default value of this property is true.

top
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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

top
Version
void get_Version(CkString &str);
const wchar_t *version(void);

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

ReadFileToString
bool ReadFileToString(const wchar_t *filename, const wchar_t *srcCharset, CkString &outStr);
const wchar_t *readFileToString(const wchar_t *filename, const wchar_t *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 true for success, false for failure.

More Information and Examples
Convert HTML to Plain Text
top
ToText
bool ToText(const wchar_t *html, CkString &outStr);
const wchar_t *toText(const wchar_t *html);

Converts HTML to plain-text.

Returns true for success, false for failure.

More Information and Examples
Convert HTML to Plain Text
top
ToTextSb
bool ToTextSb(CkStringBuilderW &sb);
Introduced in version 9.5.0.97

Converts the HTML in sb to plain-text.

Returns true for success, false for failure.

top
WriteStringToFile
bool WriteStringToFile(const wchar_t *stringToWrite, const wchar_t *filename, const wchar_t *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 true for success, false for failure.

top