CkHtmlToXml C++ Class Reference (Visual C++)
CkHtmlToXml
Class for converting HTML to well-formed XML for the purpose of programmatically extracting (scraping) information from any HTML page.
Properties
bool get_DropCustomTags(void);
void put_DropCustomTags(bool v);
If set to true, then any non-standard HTML tags will be dropped when converting to XML.
void get_Html(CkString &str);
void put_Html(const char *html);
The HTML to be converted by the ToXml method. To convert HTML to XML, first set this property to the HTML string and then call ToXml. The ConvertFile method can do file-to-file conversions.
void LastErrorHtml(CkString &str);
Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Error information in XML format for the last method called.
long get_Nbsp(void);
void put_Nbsp(long v);
Determines how to handle HTML entities. The default value, 0 will cause entites to be convert to normal space characters (ASCII value 32). If this property is set to 1, then 's will be converted to . If set to 2, then &nbps;'s are dropped.
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
void get_Version(CkString &str);
The version of the component, such as "1.0.0".
void get_XmlCharset(CkString &str);
void put_XmlCharset(const char *html);
The charset, such as "utf-8" or "iso-8859-1" of the XML to be created. If XmlCharset is empty, the XML is created in the same character encoding as the HTML. Otherwise the HTML is converted XML and converted to this charset.
Methods
bool ConvertFile(const char * inHtmlFilename, const char * outXmlFilename);
Converts an HTML file to a well-formed XML file that can be parsed for the purpose of programmatically extracting information.
void DropTagType(const char * tagName);
Allows for any specified tag to be dropped from the output XML. To drop more than one tag, call this method once for each tag type to be dropped.
void DropTextFormattingTags();
Causes text formatting tags to be dropped from the XML output. Text formatting tags are: b, font, i, u, br, center, em, strong, big, tt, s, small, strike, sub, and sup.
bool IsUnlocked();
Returns true if the component is already unlocked. Otherwise returns false.
bool ReadFileToString(const char * filename, const char * srcCharset, CkString & str);
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.
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
bool SetHtmlFromFile(const char * filename);
Sets the Html property by loading the HTML from a file.
bool ToXml(CkString & str);
Converts the HTML in the "Html" property to XML and returns the XML string. Returns true for success, false for failure.
void UndropTagType(const char * tagName);
Causes a specified type of tag to NOT be dropped in the output XML.
void UndropTextFormattingTags();
Causes text formatting tags to NOT be dropped from the XML output. Text formatting tags are: b, font, i, u, br, center, em, strong, big, tt, s, small, strike, sub, and sup.
Important: Text formatting tags are dropped by default. Call this method to prevent text formatting tags from being dropped.
bool UnlockComponent(const char * code);
Unlocks the component. An arbitrary unlock code may be passed to automatically begin a 30-day trial. Returns true for success, false for failure.
bool WriteStringToFile(const char * stringToWrite, const char * filename, const char * outpuCharset);
Convenience method for saving a string to a file. The character encoding of the output text file is specified by outpuCharset (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.
const char * html();
The HTML to be converted by the ToXml method. To convert HTML to XML, first set this property to the HTML string and then call ToXml. The ConvertFile method can do file-to-file conversions.
const char * lastErrorHtml();
Error information in HTML format for the last method called.
const char * lastErrorText();
Error information in plain-text format for the last method called.
const char * lastErrorXml();
Error information in XML format for the last method called.
const char * readFileToString(const char * filename, const char * 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.
const char * toXml();
Converts the HTML in the "Html" property to XML and returns the XML string.
const char * version();
The version of the component, such as "1.0.0".
const char * xml();
Converts the HTML in the "Html" property to XML and returns the XML string.
const char * xmlCharset();
The charset, such as "utf-8" or "iso-8859-1" of the XML to be created. If XmlCharset is empty, the XML is created in the same character encoding as the HTML. Otherwise the HTML is converted XML and converted to this charset.
|