Click or drag to resize

ImgConverter Class

This class offers the necessary API to create images in various formats from a specified web page
Inheritance Hierarchy
SystemObject
  ExpertPdf.HtmlToPdfImgConverter

Namespace: ExpertPdf.HtmlToPdf
Assembly: ephtmltopdf (in ephtmltopdf.dll) Version: 22.0.0
Syntax
public class ImgConverter

The ImgConverter type exposes the following members.

Constructors
 NameDescription
Public methodImgConverter Creates an image converter that auto detects the width and height of the web page
Public methodImgConverter(Int32) Creates an image converter for a web page with the specified width and an autodected height
Public methodImgConverter(Int32, Int32) Creates an image converter for a web page with the specified width and height
Top
Properties
 NameDescription
Public propertyAddPadding Add padding at the end of the conversion result. Default is false.
Public propertyAllowLocalAccess A flag indicating if local files can be loaded during the conversion. The default value is True and local files can be loaded.
Public propertyAuthenticationPassword Optionally set the Password property to authenticate to web server before accessing the URL to be converted (e.g handles any IIS authentication method)
Public propertyAuthenticationUsername Optionally set the Username property to authenticate to web server before accessing the URL to be converted (e.g handles any IIS authentication method)
Public propertyBinaryBehaviorsEnabled Internal use. Default is false.
Public propertyBlinkEngineLaunchMaxTries Blink engine process launch tries.
Public propertyBlinkEngineLaunchTimeout Blink engine process launch timeout, in milliseconds.
Public propertyBlinkEnginePath Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries.
Public propertyBlinkEngineTemporaryFilesPath Gets or sets the full path of a folder where Blink html rendering engine will write temporary files.
Public propertyBlinkMaxThreadPoolWorkers Upper bound for the ThreadPool worker-thread floor that the Blink engine raises to keep concurrent browser launches from starving. Set to 0 to disable this auto-tuning.
Public propertyCacheFolder Use this property to enable caching of web requests. Sets the full path of the local cache folder. Note: This is used only by the WebKit rendering engine.
Public propertyCefEnginePath Gets or sets the full path of the directory containing the ExpertPdf.Cef.exe binary.
Public propertyCefEngineTemporaryFilesPath Gets or sets the full path of a folder where the Chromium rendering engine will write temporary files.
Public propertyClickElementsDelayAfter Delay in miliseconds, after element click.
Public propertyClickElementsDelayBefore Delay in miliseconds, before element click.
Public propertyClickElementsSelectors Specifies elements from the web page that will be clicked before converting the page.
Public propertyClipHtmlView 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. Note: This is used only by the WebKit rendering engine.
Public propertyConversionDelay An additional time in seconds to wait for asynchronous items to be loaded
Public propertyCustomCSS Use this property to specify some CSS styles that will be injected into the page that is converted.
Public propertyDrawBackground Gets or sets a flag indicating if the web page background is rendered into the generated image.
Public propertyEnableOfflineMode Put the browser into offline mode before navigation, so all network requests fail.
Public propertyExternalBrowserEndpoint External browser service.
Public propertyHttpCookies 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. Note: This is used only by the WebKit rendering engine.
Public propertyHttpHeaders 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. Note: This is used only by the WebKit rendering engine.
Public propertyHttpPostParameters Gets the collection of custom HTTP POST parameters used for the conversion.
Public propertyInternalFileName Sets the full path of the helper file. Note: This is used only by the WebKit rendering engine.
Public propertyLazyImagesLoadingDelay Delay per page, in miliseconds, for lazy images loading.
Public propertyLazyImagesLoadingEnabled Enables a delay mechanism to allow images to fully load.
Public propertyLicenseKey Gets or sets the license key
Public propertyLoginOptions Handle custom page login.
Public propertyMaxConversionTime The maximum time in seconds the conversion may take after the page has loaded. Default value is 60.
Public propertyNavigationTimeout The navigation timeout in seconds. Default value is 60.
Public propertyPageHeight Gets or sets the web page height. If the width was not set aswell, this property has no effect
Public propertyPageWidth Gets or sets the web page width
Public propertyPluginsEnabled A flag indicating if plugins are enabled in converter. The default is true. Note: This is used only by the WebKit rendering engine.
Public propertyPostLoadingScript 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.
Public propertyPostLoadingScriptDelayAfter Delay in miliseconds, after post page loading javascript injection.
Public propertyProxyOptions Gets a reference to an object encapsulating the proxy options used to access the HTML document to convert. Note: This is used only by the WebKit rendering engine.
Public propertyRenderElementId Use this property to convert only a certain section of the page, specified by the html element ID. Note: This is used only by the WebKit rendering engine.
Public propertyRenderElementSelector Use this property to convert only the part of the page matched by this CSS selector.
Public propertyRenderingEngine Gets or sets the rendering engine used to load and render the HTML: Chromium (the engine of the Chrome browser, recommended for modern pages; needs the Chromium engine files), Blink (in the .NET Framework 4.6.1+ and .NET Core builds; needs the Blink engine files), WebKit (built in, the default) or WebKit2 (for restricted environments).
Public propertyRenderOnTimeout 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. Note: This is used by the WebKit and Chromium rendering engines.
Public propertySamplingEnabled Internal use only
Public propertyScriptsEnabled Enable scripts when rendering HTML to image. Default is true.
Public propertySecureProtocol Protocol used for secure (HTTPS) connections.
Public propertyStartupMode 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() Note: This is used only by the WebKit rendering engine.
Public propertyStartupScript 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. Note: This is used only by the WebKit rendering engine.
Public propertyWebGlEnabled Controls WebGL support in the rendering engine.
Public propertyWindowStatus If set, the converter waits for window.status to match this string before capturing the page.
Public propertyxDf Internal use only
Top
Methods
 NameDescription
Public methodGetImageBytesFromHtmlFile Gets binary format of an image generated from the specified HTML file in the the specified System.Drawing.Imaging.ImageFormat format. The bytes can be further written in any stream like a disk file or a web response.
Public methodGetImageBytesFromHtmlStream(Stream, Encoding, ImageFormat) Gets binary format of an image generated from the specified HTML stream in the the specified System.Drawing.Imaging.ImageFormat format. The bytes can be further written in any stream like a disk file or a web response.
Public methodGetImageBytesFromHtmlStream(Stream, Encoding, ImageFormat, String) Gets binary format of an image generated from the specified HTML stream in the the specified System.Drawing.Imaging.ImageFormat 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.
Public methodGetImageBytesFromHtmlString(String, ImageFormat) Gets binary format of an image generated from the specified HTML string in the the specified System.Drawing.Imaging.ImageFormat format. The bytes can be further written in any stream like a disk file or a web response.
Public methodGetImageBytesFromHtmlString(String, ImageFormat, String) Gets binary format of an image generated from the specified HTML string in the the specified System.Drawing.Imaging.ImageFormat 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.
Public methodGetImageBytesFromHtmlStringAsync(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.
Public methodGetImageBytesFromHtmlStringAsync(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.
Public methodGetImageBytesFromUrl Gets binary format of an image generated from the specified URL in the the specified System.Drawing.Imaging.ImageFormat format. The bytes can be further written in any stream like a disk file or a web response.
Public methodGetImageBytesFromUrlAsync Converts the specified URL into an image asynchronously and returns the image as an array of bytes in the specified format.
Public methodGetImageFromHtmlFile Gets an System.Drawing.Image object from the specified HTML file in the the specified System.Drawing.Imaging.ImageFormat format
Public methodGetImageFromHtmlStream(Stream, Encoding, ImageFormat) Gets an System.Drawing.Image object from the specified HTML stream in the the specified System.Drawing.Imaging.ImageFormat format
Public methodGetImageFromHtmlStream(Stream, Encoding, ImageFormat, String) Gets an System.Drawing.Image object from the specified HTML stream in the the specified System.Drawing.Imaging.ImageFormat 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.
Public methodGetImageFromHtmlString(String, ImageFormat) Gets an System.Drawing.Image object from the specified HTML string in the the specified System.Drawing.Imaging.ImageFormat format
Public methodGetImageFromHtmlString(String, ImageFormat, String) Gets an System.Drawing.Image object from the specified HTML string in the the specified System.Drawing.Imaging.ImageFormat 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.
Public methodGetImageFromUrl Gets an System.Drawing.Image object from the specified URL in the the specified System.Drawing.Imaging.ImageFormat format
Public methodGetImageFromUrlBytes Gets binary format of an image generated from the specified URL in the the specified System.Drawing.Imaging.ImageFormat format. The bytes can be further written in any stream like a disk file or a web response.
Obsolete
Public methodSaveImageFromHtmlFileToFile 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
Public methodSaveImageFromHtmlStreamToFile(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
Public methodSaveImageFromHtmlStreamToFile(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
Public methodSaveImageFromHtmlStringToFile(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
Public methodSaveImageFromHtmlStringToFile(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
Public methodSaveImageFromUrlToFile 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
Public methodSaveImageFromUrlToFileAsync Converts the specified URL into an image asynchronously and saves it to the specified file.
Top
See Also