HiQPdf Chromium for .NET Documentation
Html
The HTML to Image converter class that can be used to convert HTML documents to raster images
Definition
Namespace: HiQPdf.Chromium
Assembly: HiQPdf.Chromium (in HiQPdf.Chromium.dll) Version: 16.4.0
Assembly: HiQPdf.Chromium (in HiQPdf.Chromium.dll) Version: 16.4.0
C#
public class HtmlToImage- Inheritance
- Object HtmlToImage
Constructors
| HtmlToImage | The default constructor |
Properties
| AfterLoadJavaScript | A JavaScript code to execute immediately after the page was loaded. It can be used to automatically click buttons or for other operations before conversion. By default this property is null |
| Authentication | The object exposed by this propery encapsulates a username and a password that can be used to access web pages requiring HTTP authentication |
| AutoResizeBrowserHeight | Controls if the browser will be automatically resized to the HTML content height determined after the initial loading and the content will be reloaded. The auto resized height is limited by the MaxBrowserHeight property. This is useful to render web pages which load only the content which is visible in browser viewport. The default value is false |
| BrowserHeight | The browser window height in pixels. The default height is 2048 pixels |
| BrowserWidth | The browser window width in pixels. The default width is 1024 pixels |
| ConvertEntirePage | Controls if the entire HTML page content will be converted to image or only the viewport specified by the BrowserWidth and BrowserHeight properties. The converted content is limited by the MaxBrowserHeight property. The default value is true |
| ConvertEntirePageMode | The content loading mode used by the HTML to Image converter. This flag has effect only if ConvertEntirePage is also true. The default mode is Browser |
| GpuCompositingEnabled | Controls if the GPU compositing is enabled in the HTML to Image converter. It should be enabled to convert web page with WebGL. The default value is false |
| GpuRenderingEnabled | Controls if the GPU rendering is enabled in the HTML to Image converter. The default value is true |
| 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 |
| HtmlLoaderFilePath | Sets the full path of HTML loader file |
| 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 |
| LocalFilesEnabled | This property controls if the converter can convert local file. The default value is true |
| LocalhostEnabled | This property controls if the converter can convert URLs from localhost. The default value is true |
| MaxBrowserHeight | The maximum browser height in pixels. Value 0 means unlimited. The default value is 32000 pixels |
| MediaType | Controls the media type for which to render the HTML document. The default value is null and the rendering will be for 'screen' media |
| 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 false |
| 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 Internally, this property gets or sets the value of the Licensing.SerialNumber property |
| TriggerMode | The method of triggering the conversion |
| UncPathEnabled | This property controls if the converter can convert files from local network. The default value is true |
| WaitAfterLoadJavaScript | Controls if converter should wait the script from AfterLoadJavaScript to finish execution before continuing conversion. By default this property is false |
| WaitBeforeBrowserResize | Controls if the WaitBeforeConvert delay is also used when the HTML content size is determined after the intial loading. This property applies only if the AutoResizeBrowserHeight flag is on. The default value is false |
| WaitBeforeConvert | An additional time in seconds to wait before starting the conversion to allow more time to JavaScript to update the web page. The default value is 0 |
Methods
| ConvertHtmlToFile | Converts a HTML code to an image in requested format using the base URL to resolve the external references found in HTML |
| ConvertHtmlToMemory | Converts a HTML code to an image in requested 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 requested format |
| ConvertUrlToMemory | Converts the HTML document from the given URL to an image in requested 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) |