HtmlToXml ActiveX Reference Documentation

HtmlToXml

Current Version: 9.5.0.73

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

Object Creation

(Visual Basic 6.0)
Dim obj As New HtmlToXml

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.HtmlToXml")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.HtmlToXml")

(Delphi)
obj := THtmlToXml.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.HtmlToXml')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.HtmlToXml")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HtmlToXml', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.HtmlToXml");

Properties

DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DropCustomTags
DropCustomTags As Long

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

top
Html
Html As String

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.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
Nbsp
Nbsp As Long

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 &#160. If set to 2, then &nbps;'s are dropped. If set to 3, then &nbsp's are left unmodified.

top
VerboseLogging
VerboseLogging As Long

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

top
Version
Version As String (read-only)

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

top
XmlCharset
XmlCharset As String

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.

top

Methods

ConvertFile
ConvertFile(inHtmlPath As String, destXmlPath As String) As Long

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

Returns 1 for success, 0 for failure.

top
DropTagType
DropTagType(tagName As String)

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.

top
DropTextFormattingTags
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.

top
IsUnlocked
IsUnlocked() As Long

Returns 1 if the component is already unlocked. Otherwise returns 0.

top
ReadFile
ReadFile(path As String) As Variant

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

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

top
ReadFileToString
ReadFileToString(filename As String, srcCharset As String) As String

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 Nothing on failure

top
SetHtmlBytes
SetHtmlBytes(inData As Variant)

Sets the Html property from a byte array.

top
SetHtmlFromFile
SetHtmlFromFile(filename As String) As Long

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

Returns 1 for success, 0 for failure.

top
ToXml
ToXml() As String

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

Returns Nothing on failure

top
UndropTagType
UndropTagType(tagName As String)

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

top
UndropTextFormattingTags
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.

top
UnlockComponent
UnlockComponent(unlockCode As String) As Long

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

Returns 1 for success, 0 for failure.

top
WriteFile
WriteFile(path As String, fileData As Variant) As Long

Convenience method for saving a byte array to a file.

Returns 1 for success, 0 for failure.

top
WriteStringToFile
WriteStringToFile(stringToWrite As String, filename As String, charset As String) As Long

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 1 for success, 0 for failure.

top