HtmlConverterBase Class

The base class for HTML converters

Definition

Namespace: HiQPdfClient
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
C#
public abstract class HtmlConverterBase
Inheritance
Object    HtmlConverterBase
Derived

Constructors

HtmlConverterBase Creates a HTML converter to connect on the given port to a server given by IP address or by host name

Properties

AcceleratedCanvasEnabled Controls if the accelerated canvas is enabled. This property is false by default
Authentication The object exposed by this propery encapsulates a username and a password that can be used to access web pages requiring HTTP authentication
BrowserHeight The browser window height in pixels. The default height is set to render the entire HTML document
BrowserUserAgent The browser custom user agent
BrowserWidth The browser window width in pixels. The default width is 1200 pixels
BrowserZoom The browser window zoom percentage. The default zoom is 100
ConvertedHtmlElementSelector 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
DefaultCharset The default character set to be used when the character set meta tag is not set in HTML document header
ForceResourcesDownload Controls if the HTML converter should force all possible resources to be downloaded. The default value is false
HtmlLoadedTimeout 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
Http2Enabled Controls if the HTTP2 protocol is enabled in NG version. The default value is false
HttpCookies A collection of HTTP cookies to be used when accessing a web page
HttpHeaders A collection of the HTTP headers to be used when accessing a web page
HttpPostFields 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
Impersonation The object exposed by this propery encapsulates the properties controlling the internal browser impersonation
LayoutWithHinting 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
LocalFilesLoadEnabled Controls if the local files can be loaded by converter. This property is true by default
LocalStorageEnabled Controls if the local web storage is enabled. This property is false by default
ManualTriggerWaitBeforeConvert An additional time in seconds to wait before starting the conversion when the triggering mode is set to manual
MaxBrowserHeight 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
MaxImageTileHeight The maximum height in pixels of the image tiles captured by converter
MediaType 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
MinBrowserHeight 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
Port The server port number
ProbeLayout Controls if the HTML converter should do a probe layout first. The default value is false
Proxy The object exposed by this property encapsulates the parameters (address, username, password) that can be used to access web pages through a proxy server
RenderSvgFonts 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
RenderWebFonts Controls if the Web Fonts are rendered. The default value is true
RepeatHttpHeaders 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
RunExtensions Controls if the browser extensions like Flash players are executed. The default value is false and no extension is executed
RunJavaScript Controls if the JavaScript in the HTML document is executed. The default value of this property is true and the JavaScript is executed
SerialNumber The serial number obtained after product purchase. This property can be set to null or can be left not set to enter evaluation mode
Server The server IP address or host name
ServerPassword The password to access the HTML to PDF server if the server is password protected
StartBrowserHeight 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
StopSlowScripts Controls if the browser should interrupt slow scripts in the web page. The default value is false and the scripts are not stopped
Transform3DEnabled Controls if the 3D transformations are enabled. This property is false by default
TriggerMode The method of triggering the conversion
WaitBeforeConvert 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.
WebGLEnabled Controls if the WebGL is enabled. This property is false by default

Methods

Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetHashCode
(Inherited from Object)
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
ToString
(Inherited from Object)

See Also