HtmlToText CkPython Reference Documentation
CkHtmlToText
Current Version: 10.1.3
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()
Properties
DebugLogFilePath
# ckStr is a CkString
htmlToText.get_DebugLogFilePath(ckStr);
strVal = htmlToText.debugLogFilePath();
htmlToText.put_DebugLogFilePath(strVal);
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
boolVal = htmlToText.get_DecodeHtmlEntities();
htmlToText.put_DecodeHtmlEntities(boolVal);
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
# ckStr is a CkString
htmlToText.get_LastErrorHtml(ckStr);
strVal = htmlToText.lastErrorHtml();
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
# ckStr is a CkString
htmlToText.get_LastErrorText(ckStr);
strVal = htmlToText.lastErrorText();
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
# ckStr is a CkString
htmlToText.get_LastErrorXml(ckStr);
strVal = htmlToText.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
boolVal = htmlToText.get_LastMethodSuccess();
htmlToText.put_LastMethodSuccess(boolVal);
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
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.
topSuppressLinks
boolVal = htmlToText.get_SuppressLinks();
htmlToText.put_SuppressLinks(boolVal);
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
UncommonOptions
# ckStr is a CkString
htmlToText.get_UncommonOptions(ckStr);
strVal = htmlToText.uncommonOptions();
htmlToText.put_UncommonOptions(strVal);
This property usually remains an empty string but can be set to a list of comma-separated keywords.
- "NoReferencesList" - Do not generate the list of hyperlink references at the end of the plain-text.
Utf8
boolVal = htmlToText.get_Utf8();
htmlToText.put_Utf8(boolVal);
When set to True, all "const char *" arguments are interpreted as utf-8 strings. If set to False (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to True, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to False, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = htmlToText.get_VerboseLogging();
htmlToText.put_VerboseLogging(boolVal);
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
# ckStr is a CkString
htmlToText.get_Version(ckStr);
strVal = htmlToText.version();
Methods
ReadFileToString
# 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 True for success, False for failure.
ToText
# outStr is a CkString (output)
status = htmlToText.ToText(html, outStr);
retStr = htmlToText.toText(html);
Converts HTML to plain-text.
Returns True for success, False for failure.
ToTextSb
WriteStringToFile
# 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 True for success, False for failure.
top