 | |
Html | |
Html to Image Converter. This class offers the API needed to create images in various formats from
a specified web page or html string.
Inheritance HierarchySystemObject
SelectPdfHtmlToImage
SelectPdfHtmlToImage
Namespace: SelectPdf
Assembly: Select.Pdf (in Select.Pdf.dll) Version: 26.2
SyntaxThe HtmlToImage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HtmlToImage | Creates an html to image converter. Width and height of the web page are automatically detected. |
| HtmlToImage(Int32) | Creates an html to image converter. The width of the web page is specified. The height of the web page is automatically detected. |
| HtmlToImage(Int32, Int32) | Creates an html to image converter for a web page with the specified width and height. |
Properties| Name | Description | |
|---|---|---|
 | AuthenticationPassword | Specifies the password if the web page being converted requires authentication. |
| AuthenticationUsername | Specifies the username if the web page being converted requires authentication. |
| BlinkEngineLaunchMaxTries | Blink engine process launch tries. |
| BlinkEngineLaunchTimeout | Blink engine process launch timeout. |
| BlinkEnginePath | Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries. |
| BlinkEngineTemporaryFilesPath | Gets or sets the full path of a folder where Blink html rendering engine will write temporary files. |
| CefEnginePath | Gets or sets the full path of the directory containing the SelectPdf.Cef.exe binary. |
| CefEngineTemporaryFilesPath | Gets or sets the full path of a folder where the CEF rendering engine will write temporary files. |
| ClickElementsDelayAfter | Delay in miliseconds, after element click. |
| ClickElementsDelayBefore | Delay in miliseconds, before element click. |
| ClickElementsSelectors | Specifies elements from the web page that will be clicked before converting the page. |
| CustomCSS | Use this property to specify some CSS styles that will be injected into the page that is converted. |
| DenyLocalFileAccess | A flag indicating if local files can be loaded during the conversion. The default value is False and local files can be loaded. |
| DrawBackground | Gets or sets a flag indicating if the web page background is rendered into the generated image. |
| EnableOfflineMode | Put the browser into offline mode before navigation, so all network requests fail. |
| ExternalBrowserEndpoint | External browser service. |
| HttpCookies | Gets the collection of custom HTTP cookies used for the conversion. |
| HttpHeaders | Get the collection of custom HTTP headers used for the conversion. |
| HttpPostParameters | Gets the collection of custom HTTP POST parameters used for the conversion. |
| JavaScriptEnabled | Enable scripts when rendering the url or html string. |
| LazyImagesLoadingDelay | Delay per page, in miliseconds, for lazy images loading. |
| LazyImagesLoadingEnabled | Enables a delay mechanism to allow images to fully load. |
| LFN | Internal use only. |
| LoginOptions | Handle custom page login. |
| MaxConversionTime | Timeout in seconds for the capture phase (producing the image after the page has loaded). Applies to the Chromium rendering engine only. |
| MaxPageLoadTime | The web page navigation timeout in seconds. |
| MinPageLoadTime | An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered. |
| PluginsEnabled | A flag indicating if plugins (like Flash players) are enabled in the converter. |
| PostLoadingScript | Use this property to specify some JavaScript code that will be injected into the page that is converted and executed after the page was fully loaded. |
| PostLoadingScriptDelayAfter | Delay in miliseconds, after post page loading javascript injection. |
| ProxyOptions | Gets a reference to an object containing the proxy settings used to access the web page that is being converted. |
| RenderingEngine | Gets or sets the rendering engine used by the converter to load and render the HTML. The possible values are WebKit, WebKitRestricted and Blink. The Webkit rendering engine is internal and renders similar to Apple's Safari. For Blink, Chromium binaries must be also installed. |
| SecureProtocol | Protocol used for secure (HTTPS) connections. |
| StartupMode | Use this property to specify how the conversion starts. |
| StartupScript | Use this property to specify some JavaScript code that will be injected into the page that is converted. |
| VisibleWebElementId | Use this property to convert only a certain section of the web page, specified by the html element ID. |
| WebPageFixedSize | Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible. |
| WebPageHeight | Gets or sets the web page height. If the width was not set, this property has no effect. |
| WebPageWidth | Gets or sets the web page width. |
| WindowStatus | If set, the converter waits for window.status to match this string before capturing the page. |
Methods| Name | Description | |
|---|---|---|
| ConvertHtmlString(String) | Gets an Image object from the specified html string. |
| ConvertHtmlString(String, String) | Gets an Image object from the specified html string. |
| ConvertUrl | Gets an Image object from the specified url. |
See Also