HtmlToImageElement Class

Creates a URL to image converter element at the (0,0) location in PDF page. The width of element in PDF page is the available width in PDF page and the height is auto determined.

Creates a HTML string to image converter element that will be rendered at the (0,0) location in PDF page using a base URL to resolve the external resources. The width of element in PDF page is the available width in PDF page and the height is auto determined.

Creates a URL to image converter element at the specified x and y coordinates in PDF page. The width of element in PDF page is the available width in PDF page and the height is auto determined.

Creates a URL to image converter element at the specified x and y coordinates with the specified width. The height in PDF is auto determined.

Creates a HTML string to image converter element at the specified x and y coordinates in PDF page using a base URL to resolve the external resources. The width of element in PDF page is the available width in PDF page and the height is auto determined.

Creates a URL to image converter element at the specified x and y coordinates with the specified width and height.

Creates a URL to image converter element at the specified x and y coordinates with the specified width. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.

Creates a HTML string to image converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources. The height in PDF is auto determined.

Creates a HTML string to image converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources.

Create a HTML string to image converter element at the specified x and y coordinates with the specified width using a base URL to resolve the external resources. The height in PDF is auto determined. The virtual browser width in pixels is specified by the htmlViewerWidth parameter.

Create a URL to image converter element at the specified x and y coordinates with the specified width and height using a document URL to resolve the internal links. The virtual browser width and height in pixels are specified by the htmlViewerWidth and htmlViewerHeight parameters.

Creates a HTML string to image converter element at the specified x and y coordinates with the specified width and height using a base URL to resolve the external resources and a document URL to resolve the internal links. The virtual browser width and height in pixels is specified by the htmlViewerWidth and htmlViewerHeight parameters.

This property can be set with an username and a password in order to authenticate to the web server before accessing the URL to be converted in HTML to Image element. They can be used for example to resolve the IIS Integrated Windows Authentication or other types of IIS authentication.

Gets or sets the CSS selectors of the HTML elements to not be broken between PDF pages if possible when the HTML to Image element is rendered

When true this property instructs the HTML to Image element converter to try to avoid cutting off the images between PDF pages

Gets or sets element background color.

Gets or sets the base URL of the HTML string to be converted to image

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

A space in points to introduce at the bottom of PDF pages where the HTML is rendered to image. 1 point is 1/72 inch. By default the bottom spacing is 0.

If the HTML content is not entirely visible in the HTML viewer of the HTML to Image element 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.

The clip rectangle applied when the element is rendered in PDF

An additional time in seconds to wait for asynchronous items to be completely loaded or for a web page redirect to finish before starting the rendering in HTML to Image element. Default value is 0.

The default HTML document text encoding to be used if there is no charset meta tag defined in the HTML document. By default this property is not set and an auto determined text encoding will be used by converter

Gets or sets a flag indicating if the HTML to Image element should try to download all the resources even if this could cause a slower conversion. The default value is false

Gets or sets a flag indicating if the accelerated CSS 3D transformations are enabled in the HTML to Image element converter. The default value is false

Gets or sets a flag indicating if the accelerated 2D canvas is enabled in the HTML to Image element converter. The default value is false

Gets or sets a flag indicating if the HTTP2 protocol is enabled in HTML to Image element converter. The property has effect only in NE version of the library. The default value is false

Gets or sets a flag indicating if the persistent local storage is enabled in the HTML to Image element converter. The default value is false

Gets or sets a flag indicating if the WebGL is enabled in the HTML to Image element converter. The default value is false

Gets or sets a flag indicating if the HTML viewer extensions are executed in the HTML to Image element converter. The default value is false and no extension is executed. The Flash player for Mozilla Firefox must be installed in order to execute the flash content from HTML

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 or sets the destination height in points of the rendered image. If the specified height is less or equal to 0, the destination height will be auto determined so all the content can be rendered.

Gets or sets the HTML string to be converted to image

Gets an object populated after conversion with the title, keywords, and description of the converted HTML document rendered by the HTML to Image element.

Gets a reference to the object that can be used to obtain the position in PDF of the HTML elements rendered by the HTML to Image element. In order to retrieve the position in PDF for a list of HTML elements, the HtmlElementSelectors property of HtmlElementsMappingOptions class must be set with an array of strings containing the CSS selectors of the HTML elements you want to map. 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 of the HTML to Image element. If the specified HTML viewer height is 0 the HTML viewer height will be automatically determined based on the HTML content and the HTML viewer width in order to make visible the whole HTML content. The HTML viewer width is given by the HtmlViewerWidth property of the HtmlToImageElement class. 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 height can also be specified in the HtmlToImageElement class contructor. The default value is 0 to automatically determine the HTML viewer height based on the HTML content and the HTML viewer width.

Gets or sets the preferred HTML viewer width in pixels of the HTML to Image element. 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. By default the ClipHtmlView property is false and the HTML viewer is automatically extended in width to make visible the whole HTML content. The HTML viewer width can also be specified in the HtmlToImageElement class constructor. The default value is 1024 pixels.

Gets or sets the HTML viewer zoom percentage in HTML to Image element similar to zoom level in a browser. The default value of this property is 100

Returns the collection of HTTP POST fields to be used when accessing a web page in HTML to Image element. If there are elements in collection then the converter will make a POST request to the web page URL with the fields from this collection, otherwise it will make a GET request

Gets a collection of custom HTTP cookies to be sent by the HTML to Image element 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 HttpRequestCookies collection.

Gets a collection of custom HTTP headers to be sent by the HTML to Image element 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 HttpRequestHeaders collection. The PersistentHttpRequestHeaders property can be set on true to instruct the converter to send the custom headers each time an external resource (image, css, etc) referenced by the web page is requested. By default the PersistentHttpRequestHeaders property is false and the custom headers are not automatically sent to the web server when the web page resources are requested. The custom HTTP headers can be used to define cookies, authentication options, URL referrer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpRequestCookies property.

Gets or sets the maximum height in pixels of an image part in HTML to Image element

The impersonation options applied during navigation in HTML to Image element

Gets or sets the initial height in pixels of the HTML viewer in HTML to Image element. This value of this property is ignored if the HtmlViewerHeight property is set

A flag indicating if the HTML to Image element will always insert a new page in the PDF document when rendering next page instead of trying to use an already existing PDF page. This property is false by default

A flag indicating if the interactive features are enabled for hidden HTML elements. This property is false by default

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

Gets or sets a flag indicating if the slow JavaScript script should be interrupted in HTML to Image element converter. The default value is false and the scripts are not interrupted

A flag indicating if JavaScript execution is enabled in the HTML to Image element converter. The default is true.

Gets or sets the line style for elements rendering lines.

When true this option instructs the HTML to Image element converter to convert the HTML links to PDF links. The default value is true.

Gets or sets a flag indicating if the access to local files is enabled in the HTML to Image element converter. The default value is true

An additional time in seconds to wait after manual triggering before starting the rendering in HTML to Image element. Default value is 0.

Gets or sets the maximum height in pixels to be rendered from the HTML document by the HTML to Image element. The default value is 0 and the entire HTML document is rendered

Gets or sets the media type of the HTML document used by the HTML to Image element. The default media type is 'screen'. If you set this property with 'print' then the CSS properties defined in '@media print' rule will be used to render the document

Gets or sets the minimum height in pixels to be rendered from HTML document by the HTML to Image element. This value of this property is ignored if the HtmlViewerHeight property is set

The HTML to Image element converter navigation timeout in seconds. Default value is 60.

The custom user agent to be used when accessing the HTML page. When this property is null or empty the default user agent is used

Gets or sets element opacity. The opacity is expressed as a value between 0 and 100. 0 means completely transparent and 100 completely opaque. The default value of this property is 100.

Gets or sets the CSS selectors of the HTML elements after which to force a page break in PDF document

Gets or sets the CSS selectors of the HTML elements before which to force a page break in PDF document

When this property is true the HTML to Image element can be paginated to render many PDF pages if necessary.

Gets a reference to the object controlling the bookmarks creation in PDF for the HTML to Image element. In order to enable creation of bookmarks you have to set the HtmlElementSelectors property of PdfBookmarkOptions class with the CSS selectors of the HTML elements you want to bookmark.

This property can be set on true to instruct the HTML to Image element converter to send the custom headers defined by the HttpRequestHeaders property each time an external resource (image, css, etc) referenced by the web page is requested. The default value of this property is true and the custom headers are automatically sent to the web server when the web page resources are requested.

Gets or sets a flag indicating if the HTML to Image element should perform a pre-rendering. The default value is false

Gets a reference to an object encapsulating the proxy options used by the HTML to Image element to access the HTML document to convert.

Get or set the CSS selector of the HTML element to be rendered by the HTML to Image element. If the selector selects multiple HTML elements, only the the first one will be converted. The CSS selector is case sensitive. If this property is not set then the entire HTML document is rendered

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

Gets or sets a flag indicating if the footer is displayed in the even pages of the PDF document where this element is rendered

Gets or sets a flag indicating if the footer is displayed in the odd pages of the PDF document where this element is rendered

Gets or sets a flag indicating if the header is displayed in the even pages of the PDF document where this element is rendered

Gets or sets a flag indicating if the header is displayed in the odd pages of the PDF document where this element is rendered

This property has effect in HTML to Image element 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.

Gets or sets a flag indicating if the SVG fonts are enabled in HTML in the HTML to Image element converter. The default value is true

Get or sets a flag indicating if this HTML to PDF element can contribute to the PDF document table of contents. The PDF document table of contents is controlled by TableOfContents property. Default value is true

A space in points to introduce at the top of PDF pages where the HTML is rendered to image. 1 point is 1/72 inch. By default the top spacing is 0.

The conversion triggering mode used by the HTML to Image element converter. The default value is Auto

Gets or sets the URL of the HTML document to be converted to image

Gets or sets a flag indicating if the Web Fonts are enabled in HTML in the HTML to Image element converter. The default value is true

Gets or sets the destination width in points of the rendered image. If the specified width is less or equal to 0, the destination width will be given by the available width in page

Gets or sets the x position in points where the rendered image will be placed in PDF page

A flag in HTML to Image element indicating if the supplemental languages (complex script, right-to-left, East Asian) support was enabled in Windows XP Regional and Language Options. The default value is false.

Gets or sets the y position in points where the rendered image will be placed in PDF page

Determines whether the specified Object is equal to the current Object.

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Rotates the coordinate system axes clockwise by the specified angle before rendering the element. The coordinates of the element are relative to the rotated coordinates system.

Scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system is the same size as sx and sy units, respectively, in the previous coordinate system.

Skews the x axis by an skewXAngle and the y axis by an skewYAngle before rendering the element.

Returns a string that represents the current object.

Translates the coordinate system before rendering the element. The coordinates of the element are relative to the translated coordinate system.

The default virtual browser height in pixels is set to autodetect the HTML content height.

The default width in PDF of the element is set to available width in PDF page.

The default width in PDF of the element is set to available width in PDF page.

The default virtual browser width in pixels