HtmlToPdf Class

The default constructor

Controls if the accelerated canvas is enabled. This property is false by default

The object exposed by this propery encapsulates a username and a password that can be used to access web pages requiring HTTP authentication

The browser window height in pixels. The default height is set to render the entire HTML document

The browser custom user agent

The browser window width in pixels. The default width is 1200 pixels

The browser window zoom percentage. The default zoom is 100

This property is initialized after conversion with an object containing information about the converted HTML document, about the HTML elements in the HTML document and about the regions rendered in the PDF document

This property can be set with a value representing the CSS selector of the HTML element to be converted. If many elements in the HTML document are selected, only the the first one will be converted. The values of the attributes in the CSS selectors are case sensitive. If this property is not set then the whole HTML document is converted

The default character set to be used when the character set meta tag is not set in HTML document header

The properties of the object exposed by this property control the content and the aspect of the generated PDF document

Controls if the HTML converter should force all possible resources to be downloaded. The default value is false

An array of HTML CSS selectors to select the HTML elements which will not be rendered to PDF

The maximum time in seconds to wait for HTML document to be loaded. The default value is 120 seconds. An exception is thrown if the HTML document cannot be loaded in HtmlLoadedTimeout seconds

Controls if the HTTP2 protocol is enabled in NG version. The default value is false

A collection of HTTP cookies to be used when accessing a web page

A collection of the HTTP headers to be used when accessing a web page

A collection of HTTP POST fields to be used when accessing a web page. If the collection is not empty, the converter will make a POST request to the web page URL with the fields from this collection

The object exposed by this propery encapsulates the properties controlling the internal browser impersonation

Controls if the hinting is used to layout HTML. Layout hinting is disabled by default. Enabling this property can improve the layout but it can make the conversion slower

Controls if the local files can be loaded by converter. This property is true by default

Controls if the local web storage is enabled. This property is false by default

An additional time in seconds to wait before starting the conversion when the triggering mode is set to manual

This property can be used to set a maximum limit in pixels for the rendered top part of a HTML document. The default value is 0 and the height is not limited

The maximum height in pixels of the image tiles captured by converter

Controls the media type for which to render the HTML document. If this property is null or empty the default media type is 'screen'. It can be set to a value like 'print' and in this case the CSS properties defined by the '@media print' rule will be used when the HTML is rendered

This property can be used to set a minimum height in pixels to be rendered. The default value is 0 pixels. This property is ignored when the BrowserHeight property is set

Controls if the HTML converter should do a probe layout first. The default value is false

The object exposed by this property encapsulates the parameters (address, username, password) that can be used to access web pages through a proxy server

Controls if the PostScript fonts are rendered. The default value is true

Controls if the SVG fonts are rendered. The default value is false when converting HTML to PDF or SVG and true when converting HTML to a raster image

Controls if the Web Fonts are rendered. The default value is true

This property controls if the headers defined by the HttpHeaders property are also used when accessing the resources referenced by the web page, not only when accessing the web page. The default value is true and the headers are repeated when accessing the referenced resources

Controls if the HTML elements excluded from rendering can be selected for detailed information retrieval. This property is true by default

Controls if the browser extensions like Flash players are executed. The default value is false and no extension is executed

Controls if the JavaScript in the HTML document is executed. The default value of this property is true and the JavaScript is executed

An array of HTML CSS selectors to select the HTML elements for which to retrieve detailed information in SelectedHtmlElementsInfo collection exposed by ConversionInfo property

The serial number obtained after product purchase. This property can be set to null or can be left not set to enter evaluation mode

This property can be used to set the starting height in pixels of the browser. This property is ignored when the BrowserHeight property is set

Controls if the browser should interrupt slow scripts in the web page. The default value is false and the scripts are not stopped

Controls if the 3D transformations are enabled. This property is false by default

The method of triggering the conversion

If the HTML document cannot be entirely displayed in BrowserWidth pixels and the TrimToBrowserWidth is false then the browser window width will be automatically set to display the entire HTML document in the resulted PDF. If the HTML document cannot be entirely displayed in BrowserWidth pixels and the TrimToBrowserWidth is true then the browser window width will not be automatically set to display the entire HTML document and the HTML document will be trimmed

An additional time in seconds to wait before starting the conversion to allow more time to JavaScript to update the web page. When the property is set with a positive value the TriggerMode property is automatically set to WaitTime. This property has effect only if the TriggerMode property is WaitTime.

Controls if the WebGL is enabled. This property is false by default

Converts a HTML code to a PDF file

Converts a HTML code and produces a PDF document in a memory buffer

Converts a HTML code and produces a PdfDocument object that can be further modified and then saved

Converts a HTML code to a PDF document and writes the resulted PDF document to an output stream

Converts a HTML document from a given URL to a PDF file

Converts a HTML document from a given URL and produces a PDF document in a memory buffer

Converts a HTML document from a given URL and produces a PdfDocument object that can be further modified and then saved

Converts a HTML document from a given URL to a PDF document and writes the resulted PDF document to an output stream

Determines whether the specified Object is equal to the current Object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Call this method with the fully qualified name of HiQPdf.dep when this file is installed in a different folder from the HiQPdf.dll folder

Returns a string that represents the current object.

The event is raised right after the converter finished the HTML document loading and before starting the rendering to PDF

The event is raised when the converter creates a new page. This event can be used to configure the PDF page before starting layouting. For example, it is possible to set a custom header and footer for page or to hide the header and footer from page

The event is raised after the converter finished to layout the objects in a PDF page. This event can be used to layout PDF objects in the foreground of the PDF page after the main HTML content was laid out in page

The event is raised when the HTML to PDF converter prepares to layout the objects in a PDF page. This event can be used to layout PDF objects in the background of the PDF page before the main HTML content is laid out in page

The maximum number of parallel conversions