EvoPdf Chromium for .NET Documentation
Html
This class offers the necessary methods to create a raster image from a web page at given URL or from a HTML string.
The generated image can be saved into a memory buffer or into a file
Definition
Namespace: EvoPdf.Chromium
Assembly: EvoPdf.Chromium (in EvoPdf.Chromium.dll) Version: 11.4.0
Assembly: EvoPdf.Chromium (in EvoPdf.Chromium.dll) Version: 11.4.0
C#
public class HtmlToImageConverter- Inheritance
- Object HtmlToImageConverter
Constructors
| HtmlToImageConverter | Creates a HTML to Image converter object with default options |
Properties
| AuthenticationOptions | This property can be set with a username and password to authenticate with the web server before accessing the HTML page |
| AutoResizeHtmlViewerHeight | This property controls if the HTML viewer will be automatically resized to the HTML content height determined after the initial loading, followed by a content reload. The auto resized height is limited by the MaxHtmlViewerHeight property. This is useful to render web pages which load only the content which is visible in browser viewport. By default this property is false |
| CaptureEntirePage | This property controls if the entire HTML page content will be captured in screenshot or only the area specified by the HtmlViewerHeight property. The captured content is limited by the MaxHtmlViewerHeight property. By default this property is true |
| CaptureEntirePageMode | The content loading mode used by the HTML to Image converter. This flag has effect only if CaptureEntirePage is also true. The default mode is Browser |
| ConversionDelay | An additional time in seconds to wait for asynchronous items to be completely loaded or for a web page redirect to finish before starting the rendering in HTML to Image converter. It is used when the conversion triggering mode is Auto. Default value is 0 |
| GpuCompositingEnabled | A flag indicating if the GPU compositing is enabled in the HTML to Image converter. WebGL rendering requires this option to be enabled. The default value is false |
| GpuRenderingEnabled | A flag indicating if the GPU rendering is enabled in the HTML to Image converter. The default value is true |
| HtmlLoaderFilePath | Sets the full path of HTML loader file |
| HtmlViewerHeight | Gets or sets the intial HTML viewer height in pixels. The default value is 2048 pixels |
| HtmlViewerWidth | Gets or sets the preferred HTML viewer width in pixels. The default value is 1024 pixels |
| HttpPostFields | Returns the collection of HTTP POST fields to be used when accessing a web page in HTML to Image converter. If there are elements in collection then the converter will make a POST request to the web page URL with the fields from this collection, otherwise it will make a GET request |
| HttpRequestCookies | Gets a collection of custom HTTP cookies to be sent by the HTML to Image converter to the web server when the web page to convert and the resources (image, css, etc) referenced by the web page are requested. A cookie is defined by a name and a value pair that can be added to the collection using the Add(String, String) method of the HttpRequestCookies property. |
| HttpRequestHeaders | Gets a collection of custom HTTP headers to be sent by the HTML to Image converter to the web server when the web page is requested from a URL. A custom HTTP header is defined by a name and a value pair that can be added to the collection using the Add(String, String) method of the HttpRequestHeaders property. The custom HTTP headers can be used to define cookies, authentication options, URL referrer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpRequestCookies property. |
| JavaScriptEnabled | A flag indicating if JavaScript execution is enabled in HTML to Image converter The default is true. |
| LicenseKey | Gets or sets the license key string received from the vendor in HTML to Image converter. If this property is null the converter will automatically enter in evaluation mode and a demo watermark will be displayed on the generated image. Internally, this property gets or sets the value of the Licensing.LicenseKey property |
| 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 |
| MaxHtmlViewerHeight | Gets or sets the maximum HTML viewer height in pixels. Value 0 means unlimited. The default value is 32000 pixels |
| MediaType | Gets or sets the media type of the HTML document used by the HTML to Image converter. By default is not set to any value and the rendering will be for 'screen' CSS media |
| NavigationTimeout | The HTML to Image converter navigation timeout in seconds. Default value is 120 |
| PersistentHttpRequestHeaders | This property can be set to `true` to instruct the HTML to PDF converter to send the custom headers defined by the `HttpRequestHeaders` property whenever an external resource (e.g., images, CSS, etc.) referenced by the web page is requested. The default value of this property is `false` |
| ScriptToExecuteAfterLoad | 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 |
| TriggeringMode | The conversion triggering mode used by the HTML to Image converter. The default value is Auto. |
| UncPathEnabled | This property controls if the converter can convert files from local network. The default value is true |
| UseDelayForViewerResize | This property controls if the ConversionDelay is also applied during the initial loading when the HTML content size is determined. This propery has effect only if the AutoResizeHtmlViewerHeight flag is on. By default this property is false for faster conversion |
| WaitForAfterLoadScript | A flag indicating if the HTML to PDF converter should wait for the script specified by ScriptToExecuteAfterLoad to finish execution before continuing conversion. By default, this flag is set to false and the HTML to PDF conversion continues immediately after the script is injected |
Methods
| ConvertHtml | Converts a HTML string to image using a base URL to resolve external resources and returns the rendered image into a memory buffer |
| ConvertHtmlToFile | Converts a HTML string to image using a base URL to resolve external resources and writes the rendered image into a file |
| ConvertUrl | Converts an URL to image and returns the rendered image into a memory buffer |
| ConvertUrlToFile | Converts an URL to image and writes the generated image into a file |
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |