Click or drag to resize

ImgConverter Properties

The ImgConverter type exposes the following members.

Properties
 NameDescription
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 with HTTP authentication before accessing the URL to be converted
Public propertyAuthenticationUsername Optionally set the Username property to authenticate to web server with HTTP authentication before accessing the URL to be converted
Public propertyCefEnginePath Gets or sets the full path of the folder containing the Chromium rendering engine.
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.
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 propertyForceOutOfProcess Runs this conversion in a separate engine process, whatever ChromiumEngineHostMode says.
Public propertyHttpCache Selects what the rendering engine's HTTP cache keeps from this conversion for the next one.
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.
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.
Public propertyHttpPostParameters Gets the collection of custom HTTP POST parameters used for the conversion.
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 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.
Public propertyRenderElementId Use this property to convert only a certain section of the page, specified by the html element ID.
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, and where it runs: on this machine (Chromium) or in a remote ExpertPdf engine (ChromiumRemote).
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.
Public propertyScriptsEnabled Enable scripts when rendering HTML to image. Default is true.
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()
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.
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.
Top
See Also