HtmlToImageElement Properties

Add padding at the end of the conversion result. Default is false.

A flag indicating if local files can be loaded during the conversion. The default value is True and local files can be loaded.

Server authentication options (e.g IIS authentication)

Gets or sets element background color.

Set this true when using the converter for batch conversion in a loop

Enable behaviors when rendering HTML to image. Default is false.

Internal use. Default is false.

Gets or sets blending mode for transparent rendering mode of the element.

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.

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 HtmlViewerWidth property. The default value of this property is false. Note: This is used only by the WebKit rendering engine.

Gets or sets color space for element rendering.

An additional time in seconds to wait for asynchronous items to be loaded

When this property is true the resulted image will be resized if necessary to fit the available height in PDF page. By default this property is false.

When this property is true the resulted image will be resized if necessary to fit the available width in PDF page. When false the image will be rendered at the real size. By default this property is true and the image will be resized if necessary to fit the available width in PDF page

Gets or sets the element foreground color.

The gradient used to fill a shape.

Gets an object populated after conversion with the title, keywords, and description of the converted HTML document.

Gets a reference to the object controlling the retrieval of HTML elements position in the generated PDF. In order to retrieve the position in PDF for a list of HTML elements, the HtmlElementIds property of HtmlElementsMappingOptions must be set with an array of strings containing the HTML IDs of the HTML elements. The positions of the HTML elements in the generated PDF document will be returned in the HtmlElementsMappingResult object after the element was added to the page.

Gets or sets the HTML viewer height in pixels. If the viewer width was not set, this property has no effect

Gets or sets the HTML viewer width in pixels

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.

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.

Sets the full path of the helper file. Note: This is used only by the WebKit rendering engine.

When true this options instructs the converter to convert the internal HTML links to internal PDF links. The default value is true.

Specifies the internet security zone settings used by the HTML converter to convert web sites.

Gets or sets the line style for elements rendering lines.

When true this options instructs the converter to convert the HTML links in PDF links. The default value is true.

The navigation timeout in seconds. Default value is 60.

When this property is true the library will try to release the unused memory as soon as possible. The default value is false.

When true the element can be paginated

Gets a reference to the object controlling the bookmarks creation for the rendered PDF document. In order to enable creation of bookmarks you have to set the TagNames property of PdfBookmarkOptions with the names of the HTML tags you want to bookmark.

A flag indicating if plugins are enabled in converter. The default is true. Note: This is used only by the WebKit rendering engine.

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.

The bounds of the rendered rectangle on each PDF page. This property is assigned after the element has been added to a PDF page.

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.

Gets or sets the rendering engine used by the converter to load and render the html. The possible values are WebKit and IE. The Webkit rendering engine is internal and renders similar to Chrome and Safari. For IE, the component uses the IE engine from the machine.

A flag to indicate if this element was rotated.

Internal use only

A flag to indicate if this element was scaled.

Enable scripts when rendering HTML to image. Default is true.

A flag indicating if the download and execution of the HTML code is serialized when the converter is called simultaneously from multiple threads of an application. Default value is false.

Show or not the document footer on even pages generated by this element. By default the footer is displayed both on odd and even pages.

Show or not the document footer on odd pages generated by this element. By default the footer is displayed both on odd and even pages. The ShowFooterTemplate property of the page to which this element is added has priority over ShowFooterOnOddPages.

Show or not the document header on even pages generated by this element. By default the header is displayed both on odd and even pages.

Show or not the document header on odd pages generated by this element. By default the header is displayed both on odd and even pages. The ShowHeaderTemplate property of the page to which this element is added has priority over ShowHeaderOnOddPages.

A flag to indicate if this element was skewed.

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.

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.

This property has effect only when FitWidth property is true. When FitWidth is true and this property is true the HTML content will be stretched if necessary to fit the available width in PDF page. By default this property is false and the content will not be stretched to fit the available width in PDF page.

A flag to indicate if this element was translated.

Gets or sets element transparency. The transparency is expressed as a value between 0 and 100. 0 means completely transparent and 100 completely opaque.