HiQPdf Client for .NET Core
Html
The HTML to Image converter class that can be used to convert HTML documents to raster images
Definition
Namespace: HiQPdfClient
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
Assembly: HiQPdfClient.NetCore (in HiQPdfClient.NetCore.dll) Version: 16.0.0
C#
public class HtmlToImage : HtmlConverterBaseVB
Public Class HtmlToImage
Inherits HtmlConverterBaseC++
public ref class HtmlToImage : public HtmlConverterBaseF#
type HtmlToImage =
class
inherit HtmlConverterBase
end- Inheritance
- Object HtmlConverterBase HtmlToImage
Constructors
| HtmlToImage(String) | Creates a HTML to Image converter to connect on default port to a server given by IP address or by host name |
| HtmlToImage(String, UInt32) | Creates a HTML to Image 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
(Inherited from HtmlConverterBase) |
| Authentication |
The object exposed by this propery encapsulates a username and a password that can be used
to access web pages requiring HTTP authentication
(Inherited from HtmlConverterBase) |
| BrowserHeight |
The browser window height in pixels. The default height is set to render the entire HTML document
(Inherited from HtmlConverterBase) |
| BrowserUserAgent |
The browser custom user agent
(Inherited from HtmlConverterBase) |
| BrowserWidth |
The browser window width in pixels. The default width is 1200 pixels
(Inherited from HtmlConverterBase) |
| BrowserZoom |
The browser window zoom percentage. The default zoom is 100
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| DefaultCharset |
The default character set to be used when the character set meta tag is not set in HTML document header
(Inherited from HtmlConverterBase) |
| ForceResourcesDownload |
Controls if the HTML converter should force all possible resources to be downloaded. The default value is false
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| Http2Enabled |
Controls if the HTTP2 protocol is enabled in NG version. The default value is false
(Inherited from HtmlConverterBase) |
| HttpCookies |
A collection of HTTP cookies to be used when accessing a web page
(Inherited from HtmlConverterBase) |
| HttpHeaders |
A collection of the HTTP headers to be used when accessing a web page
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| ImageTiling | Controls if the large images are tiled. This property is true by default |
| Impersonation |
The object exposed by this propery encapsulates the properties controlling the internal browser impersonation
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| LocalFilesLoadEnabled |
Controls if the local files can be loaded by converter. This property is true by default
(Inherited from HtmlConverterBase) |
| LocalStorageEnabled |
Controls if the local web storage is enabled. This property is false by default
(Inherited from HtmlConverterBase) |
| ManualTriggerWaitBeforeConvert |
An additional time in seconds to wait before starting the conversion when the triggering mode is set to manual
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| MaxImageTileHeight |
The maximum height in pixels of the image tiles captured by converter
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| Port |
The server port number
(Inherited from HtmlConverterBase) |
| ProbeLayout |
Controls if the HTML converter should do a probe layout first. The default value is false
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| RenderWebFonts |
Controls if the Web Fonts are rendered. The default value is true
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| RunExtensions |
Controls if the browser extensions like Flash players are executed. The default value is false and no extension is executed
(Inherited from HtmlConverterBase) |
| RunJavaScript |
Controls if the JavaScript in the HTML document is executed. The default value of this property is true and the JavaScript is executed
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| Server |
The server IP address or host name
(Inherited from HtmlConverterBase) |
| ServerPassword |
The password to access the HTML to PDF server if the server is password protected
(Inherited from HtmlConverterBase) |
| 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
(Inherited from HtmlConverterBase) |
| StopSlowScripts |
Controls if the browser should interrupt slow scripts in the web page. The default value is false and the scripts are not stopped
(Inherited from HtmlConverterBase) |
| Transform3DEnabled |
Controls if the 3D transformations are enabled. This property is false by default
(Inherited from HtmlConverterBase) |
| TransparentImage | Controls if the resulted image has a transparent background when converting a HTML document without background. This property is false by default |
| TriggerMode |
The method of triggering the conversion
(Inherited from HtmlConverterBase) |
| TrimToBrowserWidth | 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 image. 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 |
| 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.
(Inherited from HtmlConverterBase) |
| WebGLEnabled |
Controls if the WebGL is enabled. This property is false by default
(Inherited from HtmlConverterBase) |
Methods
| ConvertHtmlToFile | Converts a HTML string to an image file in a given format |
| ConvertHtmlToImageParts | Converts a HTML code to an image represented as an array of image parts to avoid working with very large images in memory |
| ConvertHtmlToMemory | Converts a HTML code to an image in a given format using the base URL to resolve the external references found in HTML |
| ConvertUrlToFile | Converts the HTML document from the given URL to an image file in a given format |
| ConvertUrlToImageParts | Converts the HTML document from the given URL to an image represented as an array of image parts to avoid working with very large images in memory |
| ConvertUrlToMemory | Converts the HTML document from the given URL to an image in a given format |
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |