Chilkat C# HtmlToXml Class Reference

HtmlToXml

Class for converting HTML to well-formed XML for the purpose of programmatically extracting (scraping) information from any HTML page.

Object Creation

(C#)
Chilkat.HtmlToXml obj = new Chilkat.HtmlToXml();
(VB.NET)
Dim obj As New Chilkat.HtmlToXml()

Properties

public bool DropCustomTags {get; set; }

If set to true, then any non-standard HTML tags will be dropped when converting to XML.

public string Html {get; set; }

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.

public string LastErrorHtml {get; }

Error information in HTML format for the last method called.

public string LastErrorText {get; }

Error information in plain-text format for the last method called.

public string LastErrorXml {get; }

Error information in XML format for the last method called.

public int Nbsp {get; set; }

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.

public string Version {get; }

The version of the component, such as "1.0.0".

public string XmlCharset {get; set; }

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

public bool ConvertFile(string inHtmlFilename, string outXmlFilename);

Converts an HTML file to a well-formed XML file that can be parsed for the purpose of programmatically extracting information.

public void DropTagType(string 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.

public 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.

public bool IsUnlocked();

Returns true if the component is already unlocked. Otherwise returns false.

public byte[] ReadFile(string filename);

Convenience method for reading a complete file into a byte array.

Returns null on failure

public 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 a null on failure

public bool SaveLastError(string filename);

Saves the last error information to an XML formatted file.

public void SetHtmlBytes(byte[] inData);

Sets the Html property from a byte array.

public bool SetHtmlFromFile(string filename);

Sets the Html property by loading the HTML from a file.

public string ToXml();

Converts the HTML in the "Html" property to XML and returns the XML string.

Returns a null on failure

public void UndropTagType(string tagName);

Causes a specified type of tag to NOT be dropped in the output XML.

public 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.

public bool UnlockComponent(string unlockCode);

Unlocks the component. An arbitrary unlock code may be passed to automatically begin a 30-day trial.

Returns true for success, false for failure.

public bool WriteFile(string filename, byte[] fileData);

Convenience method for saving a byte array to a file.

public bool WriteStringToFile(string stringToWrite, string filename, string 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.