Img |
The ImgConverter type exposes the following members.
| Name | Description | |
|---|---|---|
| ImgConverter | Creates an image converter that auto detects the width and height of the web page | |
| ImgConverter(Int32) | Creates an image converter for a web page with the specified width and an autodected height | |
| ImgConverter(Int32, Int32) | Creates an image converter for a web page with the specified width and height |
| Name | Description | |
|---|---|---|
| AllowLocalAccess | A flag indicating if local files can be loaded during the conversion. The default value is True and local files can be loaded. | |
| AuthenticationPassword | Optionally set the Password property to authenticate to web server with HTTP authentication before accessing the URL to be converted | |
| AuthenticationUsername | Optionally set the Username property to authenticate to web server with HTTP authentication before accessing the URL to be converted | |
| CefEnginePath | Gets or sets the full path of the folder containing the Chromium rendering engine. | |
| CefEngineTemporaryFilesPath | Gets or sets the full path of a folder where the Chromium 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. | |
| ClipHtmlView | If the HTML content is not entirely visible in the HTML viewer at the specified width, the ClipHtmlView property will control whether the HTML content is clipped or the HTML viewer width is automatically extended to make visible the whole HTML content. The HTML viewer width is given by the PageWidth property. The default value of this property is false. | |
| ConversionDelay | An additional time in seconds to wait for asynchronous items to be loaded | |
| CustomCSS | Use this property to specify some CSS styles that will be injected into the page that is converted. | |
| 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. | |
| ForceOutOfProcess | Runs this conversion in a separate engine process, whatever ChromiumEngineHostMode says. | |
| HttpCache | Selects what the rendering engine's HTTP cache keeps from this conversion for the next one. | |
| HttpCookies | Gets a collection of custom HTTP cookies to be sent by the 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 HttpCookies property. | |
| HttpHeaders | Gets a collection of custom HTTP headers to be sent by the 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 HttpHeaders property. The custom HTTP headers can be used to define cookies, authentication options, URL referer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpCookies property. | |
| HttpPostParameters | Gets the collection of custom HTTP POST parameters used for the conversion. | |
| LazyImagesLoadingDelay | Delay per page, in miliseconds, for lazy images loading. | |
| LazyImagesLoadingEnabled | Enables a delay mechanism to allow images to fully load. | |
| LicenseKey | Gets or sets the license key | |
| LoginOptions | Handle custom page login. | |
| MaxConversionTime | The maximum time in seconds the conversion may take after the page has loaded. Default value is 60. | |
| NavigationTimeout | The navigation timeout in seconds. Default value is 60. | |
| PageHeight | Gets or sets the web page height. If the width was not set aswell, this property has no effect | |
| PageWidth | Gets or sets the web page width | |
| 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 encapsulating the proxy options used to access the HTML document to convert. | |
| RenderElementId | Use this property to convert only a certain section of the page, specified by the html element ID. | |
| RenderElementSelector | Use this property to convert only the part of the page matched by this CSS selector. | |
| RenderingEngine | Gets or sets the rendering engine used to load and render the HTML, and where it runs: on this machine (Chromium) or in a remote ExpertPdf engine (ChromiumRemote). | |
| RenderOnTimeout | A flag indicating if the page is rendered even if a navigation timeout occurs. The default value is false and a navigation timeout exception is raised. | |
| ScriptsEnabled | Enable scripts when rendering HTML to image. Default is true. | |
| StartupMode | Use this property to specify the converter startup mode. By default this is set to Automatic and the conversion is started as soon as the page loads (and ConversionDelay elapses). If set to Manual, the conversion is started only by a javascript call to ExpertPdfJSObj.startConversion() | |
| StartupScript | Use this property to specify some JavaScript code that will be injected into the page that is converted. The JavaScript code specified here will run before any other script on the page. | |
| WebGlEnabled | Controls WebGL support in the rendering engine. | |
| WindowStatus | If set, the converter waits for window.status to match this string before capturing the page. |
| Name | Description | |
|---|---|---|
| GetImageBytesFromHtmlFile | Gets binary format of an image generated from the specified HTML file in the specified format. The bytes can be further written in any stream like a disk file or a web response. | |
| GetImageBytesFromHtmlStream(Stream, Encoding, ImageFormat) | Gets binary format of an image generated from the specified HTML stream in the specified format. The bytes can be further written in any stream like a disk file or a web response. | |
| GetImageBytesFromHtmlStream(Stream, Encoding, ImageFormat, String) | Gets binary format of an image generated from the specified HTML stream in the specified format. The urlBase parameter allows the converter to determine the full URLs from relative URLs for images and CSS files appearing in the HTML code from htmlString parameter. The bytes can be further written in any stream like a disk file or a web response. | |
| GetImageBytesFromHtmlString(String, ImageFormat) | Gets binary format of an image generated from the specified HTML string in the specified format. The bytes can be further written in any stream like a disk file or a web response. | |
| GetImageBytesFromHtmlString(String, ImageFormat, String) | Gets binary format of an image generated from the specified HTML string in the specified format. The bytes can be further written in any stream like a disk file or a web response. The urlBase parameter allows the converter to determine the full URLs from relative URLs for images and CSS files appearing in the HTML code from htmlString parameter. | |
| GetImageBytesFromHtmlStringAsync(String, ImageFormat, CancellationToken) | Converts the specified HTML string into an image asynchronously and returns the image as an array of bytes in the specified format. | |
| GetImageBytesFromHtmlStringAsync(String, ImageFormat, String, CancellationToken) | Converts the specified HTML string into an image asynchronously and returns the image as an array of bytes in the specified format. | |
| GetImageBytesFromUrl | Gets binary format of an image generated from the specified URL in the specified format. The bytes can be further written in any stream like a disk file or a web response. | |
| GetImageBytesFromUrlAsync | Converts the specified URL into an image asynchronously and returns the image as an array of bytes in the specified format. | |
| GetImageFromHtmlFile | Converts the specified HTML file into an image and returns the image as an array of bytes in the specified format | |
| GetImageFromHtmlStream(Stream, Encoding, ImageFormat) | Converts the specified HTML stream into an image and returns the image as an array of bytes in the specified format | |
| GetImageFromHtmlStream(Stream, Encoding, ImageFormat, String) | Converts the specified HTML stream into an image and returns the image as an array of bytes in the specified format. The urlBase parameter allows the converter to determine the full URLs from relative URLs for images and CSS files appearing in the HTML code from htmlStream parameter. | |
| GetImageFromHtmlString(String, ImageFormat) | Converts the specified HTML string into an image and returns the image as an array of bytes in the specified format | |
| GetImageFromHtmlString(String, ImageFormat, String) | Converts the specified HTML string into an image and returns the image as an array of bytes in the specified format. The urlBase parameter allows the converter to determine the full URLs from relative URLs for images and CSS files appearing in the HTML code from htmlString parameter. | |
| GetImageFromUrl | Converts the specified URL into an image and returns the image as an array of bytes in the specified format | |
| GetImageFromUrlBytes |
Gets binary format of an image generated from the specified URL in the
specified format. The bytes can be further written in
any stream like a disk file or a web response.
Obsolete | |
| SaveImageFromHtmlFileToFile | This method produces a image from the specified HTML file in the specified format and saves the image in the specified disk file. The existing file will be overwritten | |
| SaveImageFromHtmlStreamToFile(Stream, Encoding, ImageFormat, String) | This method produces a image from the specified HTML stream in the specified format and saves the image in the specified disk file. The existing file will be overwritten | |
| SaveImageFromHtmlStreamToFile(Stream, Encoding, ImageFormat, String, String) | This method produces a image from the specified HTML stream in the specified format and saves the image in the specified disk file. The existing file will be overwritten | |
| SaveImageFromHtmlStringToFile(String, ImageFormat, String) | This method produces a image from the specified HTML string in the specified format and saves the image in the specified disk file. The existing file will be overwritten | |
| SaveImageFromHtmlStringToFile(String, ImageFormat, String, String) | This method produces a image from the specified HTML string in the specified format and saves the image in the specified disk file. The existing file will be overwritten | |
| SaveImageFromUrlToFile | This method produces a image from the specified URL in the specified format and saves the image in the specified disk file. The existing file will be overwritten | |
| SaveImageFromUrlToFileAsync | Converts the specified URL into an image asynchronously and saves it to the specified file in the specified format. |