export_html_to_file

Converts a document to HTML format, so that it can be viewed in a web browser without requiring the native application.

Unlike the filter() method, export_html_to_file() operates recursively on containers and mail files. OpenText recommends that you run it on the top level file.

The output path that you provide is a path (including a file name) to the exported HTML file. Be aware that this method might create auxiliary files such as images and other HTML files - and might create subfolders - in the same directory.

The HTML output might not include all content that is present in the filter output, such as headers and footers.

NOTE: There are several requirements that must be met in order to use this method:

  • Your license must enable HTML Export.
  • You must copy the binaries provided in the PLATFORM/html directory of the SDK into the PLATFORM/bin directory. The SDK does not include these binaries in the bin directory, to avoid the increase in size for applications that do not require HTML Export.
  • When viewing the exported HTML in a web browser, you must have JavaScript enabled.

Syntax

void export_html_to_file(const std::string& outputPath) const;