HiQPdf Documentation

HtmlConverterBase Class

Quickly Create High Quality PDFs
The base class for HTML converters
Inheritance Hierarchy

SystemObject
  HiQPdfHtmlConverterBase
    HiQPdfHtmlToImage
    HiQPdfHtmlToPdf
    HiQPdfHtmlToSvg

Namespace:  HiQPdf
Assembly:  HiQPdf (in HiQPdf.dll) Version: 12.0.0.0
Syntax

public abstract class HtmlConverterBase

The HtmlConverterBase type exposes the following members.

Constructors

  NameDescription
Protected methodHtmlConverterBase
Default constructor
Top
Properties

  NameDescription
Public propertyAcceleratedCanvasEnabled
Controls if the accelerated canvas is enabled. This property is false by default
Public propertyAuthentication
The object exposed by this propery encapsulates a username and a password that can be used to access web pages requiring HTTP authentication
Public propertyBrowserHeight
The browser window height in pixels. The default height is set to render the entire HTML document
Public propertyBrowserUserAgent
The browser custom user agent
Public propertyBrowserWidth
The browser window width in pixels. The default width is 1200 pixels
Public propertyBrowserZoom
The browser window zoom percentage. The default zoom is 100
Public propertyConvertedHtmlElementSelector
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
Public propertyDefaultCharset
The default character set to be used when the character set meta tag is not set in HTML document header
Public propertyForceResourcesDownload
Controls if the HTML converter should force all possible resources to be downloaded. The default value is false
Public propertyHtmlLoadedTimeout
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
Public propertyHttp2Enabled
Controls if the HTTP2 protocol is enabled in NG version. The default value is false
Public propertyHttpCookies
A collection of HTTP cookies to be used when accessing a web page
Public propertyHttpHeaders
A collection of the HTTP headers to be used when accessing a web page
Public propertyHttpPostFields
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
Public propertyImpersonation
The object exposed by this propery encapsulates the properties controlling the internal browser impersonation
Public propertyLayoutWithHinting
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
Public propertyLocalFilesLoadEnabled
Controls if the local files can be loaded by converter. This property is true by default
Public propertyLocalStorageEnabled
Controls if the local web storage is enabled. This property is false by default
Public propertyManualTriggerWaitBeforeConvert
An additional time in seconds to wait before starting the conversion when the triggering mode is set to manual
Public propertyMaxBrowserHeight
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
Public propertyMaxImageTileHeight
The maximum height in pixels of the image tiles captured by converter
Public propertyMediaType
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
Public propertyMinBrowserHeight
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
Public propertyProbeLayout
Controls if the HTML converter should do a probe layout first. The default value is false
Public propertyProxy
The object exposed by this property encapsulates the parameters (address, username, password) that can be used to access web pages through a proxy server
Public propertyRenderSvgFonts
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
Public propertyRenderWebFonts
Controls if the Web Fonts are rendered. The default value is true
Public propertyRepeatHttpHeaders
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
Public propertyRunExtensions
Controls if the browser extensions like Flash players are executed. The default value is false and no extension is executed
Public propertyRunJavaScript
Controls if the JavaScript in the HTML document is executed. The default value of this property is true and the JavaScript is executed
Public propertySerialNumber
The serial number obtained after product purchase. This property can be set to null or can be left not set to enter evaluation mode
Public propertyStartBrowserHeight
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
Public propertyStopSlowScripts
Controls if the browser should interrupt slow scripts in the web page. The default value is false and the scripts are not stopped
Public propertyTransform3DEnabled
Controls if the 3D transformations are enabled. This property is false by default
Public propertyTriggerMode
The method of triggering the conversion
Public propertyWaitBeforeConvert
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.
Public propertyWebGLEnabled
Controls if the WebGL is enabled. This property is false by default
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetDepFilePath
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
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference