HtmlToImageElement Class


HtmlToImageElement Class

Renders an HTML document or a web page to an image and draws it onto a pdf page (full edition only).

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfPageElement
SelectPdf.UniversalHtmlToImageElement

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public class HtmlToImageElement : PdfPageElement

Public Class HtmlToImageElement
	Inherits PdfPageElement

The HtmlToImageElement type exposes the following members.

Constructors

	Name	Description
	HtmlToImageElement(String)	Creates an element that renders the web page at the specified url.
	HtmlToImageElement(String, String)	Creates an element that renders the specified HTML string, resolving relative urls against the base url.
	HtmlToImageElement(Single, Single, String)	Creates an element that renders the url at position (x, y).
	HtmlToImageElement(Single, Single, Single, String)	Creates an element that renders the url at (x, y) with the given width.
	HtmlToImageElement(Single, Single, String, String)	Creates an element that renders the HTML string at position (x, y).
	HtmlToImageElement(Single, Single, Single, Single, String)	Creates an element that renders the url in the rectangle (x, y, width, height).
	HtmlToImageElement(Single, Single, Single, String, String)	Creates an element that renders the HTML string at (x, y) with the given width.
	HtmlToImageElement(Single, Single, Single, Single, String, String)	Creates an element that renders the HTML string in the rectangle (x, y, width, height).

Top

Properties

	Name	Description
	ActualText	Gets or sets the exact text represented by this element (the structure element's /ActualText entry), used when the drawn glyphs do not map to readable text. (Inherited from PdfPageElement)
	AlternateText	Gets or sets the alternate text describing this element for assistive technology (the structure element's /Alt entry). Required on figures for PDF/UA conformance. (Inherited from PdfPageElement)
	Artifact	Gets or sets a value indicating whether this element is an artifact — decorative or layout content that carries no meaning and is excluded from the logical structure (backgrounds, rules, running headers). Takes precedence over TagType. (Inherited from PdfPageElement)
	AuthenticationPassword	The password for HTTP basic authentication.
	AuthenticationUsername	The user name for HTTP basic authentication.
	ChromiumEnginePath	The full path of the Chromium rendering engine used to render the html. When not set, the engine is resolved automatically from the application folder.
	ChromiumEngineTemporaryFilesPath	The path where the Chromium rendering engine writes its temporary files. When not set, the system temporary folder is used.
	ClickElementsDelayAfter	Delay (ms) after clicking the elements.
	ClickElementsDelayBefore	Delay (ms) before clicking the elements.
	ClickElementsSelectors	CSS selectors of elements to click before capturing.
	ConversionDelay	Additional time in seconds the converter waits after the web page has loaded, before it is rendered.
	CustomCSS	Extra CSS injected into the page before capture.
	DenyLocalFileAccess	When true, local file access is denied during the conversion.
	DrawBackground	Whether the page background is drawn into the image. Default true.
	EnableOfflineMode	Whether the browser runs in offline mode.
	ForceOutOfProcess	Runs this element's rendering in a separate engine process, whatever ChromiumEngineHostMode says.
	Height	The destination height (points); -1 preserves the image aspect ratio.
	HttpCache	Selects what the engine's HTTP cache keeps from this conversion for the next one.
	HttpCookies	HTTP cookies sent with the request.
	HttpHeaders	Additional HTTP request headers.
	HttpPostParameters	HTTP POST parameters.
	JavaScriptEnabled	Whether JavaScript is enabled during rendering. Default true.
	LazyImagesLoadingDelay	Delay (ms) used while triggering lazy image loading. Default 40.
	LazyImagesLoadingEnabled	Whether lazy-loaded images are forced to load. Default true.
	LFN	Path of the diagnostic log file written during conversion. When unset, no log is written.
	LoginOptions	Form-login options performed before navigating to the target page.
	MaxConversionTime	Maximum time (seconds) for the conversion. Default 60.
	MaxPageLoadTime	The time in seconds to wait for the web page to load. Obsolete: use NavigationTimeout. Obsolete
	MinPageLoadTime	Additional time in seconds to wait before the web page is rendered. Obsolete: use ConversionDelay. Obsolete
	NavigationTimeout	The time in seconds the converter waits for the web page to load.
	PostLoadingScript	JavaScript run after the page loads, before capture.
	PostLoadingScriptDelayAfter	Delay (ms) after running PostLoadingScript.
	ProxyOptions	Proxy settings for the conversion.
	RenderingEngine	Gets or sets the rendering engine used to load and render the html.
	StartupMode	The startup mode of the conversion.
	StartupScript	JavaScript run at startup in Manual startup mode.
	TagType	Gets or sets the structure type used to tag this element in a tagged (accessible) document. Ignored unless the document's tagged mode (PdfDocument.Tagged) is enabled. Null (default) leaves the element untagged unless Artifact is set. (Inherited from PdfPageElement)
	VisibleWebElementId	Convert only the html element with the specified id. Obsolete
	VisibleWebElementSelector	Convert only the part of the page matched by this CSS selector; the rest is ignored.
	WebGlEnabled	Controls WebGL support in the rendering engine.
	WebPageFixedSize	When true, the virtual browser uses the exact width / height without auto-sizing.
	WebPageHeight	The virtual browser height, in pixels. Default 0 (auto).
	WebPageWidth	The virtual browser width, in pixels. Default 1024.
	Width	The destination width (points); -1 fits the available page width.
	WindowStatus	When set, the engine waits until window.status equals this value before capturing.
	X	The x position (points) where the image is placed.
	Y	The y position (points) where the image is placed.

Top

Remarks

The HTML is rendered to a PNG by the conversion engine (see HtmlToImage) and drawn at the element's rectangle. Width = -1 fits the available page width; Height = -1 preserves the image aspect ratio.

Example

Copy

PdfDocument document = new PdfDocument();
PdfPage page = document.AddPage();
HtmlToImageElement element = new HtmlToImageElement(0, 0, "<h1>Snapshot</h1>", "");
page.Add(element);
document.Save("out.pdf");
document.Close();

Dim document As New PdfDocument()
Dim page As PdfPage = document.AddPage()
Dim element As New HtmlToImageElement(0, 0, "<h1>Snapshot</h1>", "")
page.Add(element)
document.Save("out.pdf")
document.Close()

Reference

SelectPdf.Universal Namespace