HtmlToText Java Reference Documentation
CkHtmlToText
Current Version: 10.1.2
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
CkHtmlToText obj = new CkHtmlToText();
Properties
DebugLogFilePath
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);
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.
DecodeHtmlEntities
void put_DecodeHtmlEntities(boolean 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.
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
void put_LastMethodSuccess(boolean 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.
topRightMargin
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.
topSuppressLinks
void put_SuppressLinks(boolean 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 chilkatThe default value of this property is true. top
VerboseLogging
void put_VerboseLogging(boolean 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.
topVersion
Methods
ReadFileToString
String readFileToString(String filename, String 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.
ToText
Converts HTML to plain-text.
Returns true for success, false for failure.
ToTextSb
WriteStringToFile
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