HtmlToPdfOptions Class


HtmlToPdfOptions Class

This class contains various options used for the html to pdf conversion (page size and orientation, margins, web page dimensions, JavaScript, css media type, compression, security, document information, and more).

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalHtmlToPdfOptions

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

Syntax

Copy

public class HtmlToPdfOptions

Public Class HtmlToPdfOptions

The HtmlToPdfOptions type exposes the following members.

Constructors

	Name	Description
	HtmlToPdfOptions

Top

Properties

	Name	Description
	AllowContentHeightResize	A flag indicating if the content height can be recalculated to better fit the page. This can introduce certain errors in some cases. The default is True. Set it to False if content is split to more pages than expected.
	Authentication	Handles authentication options if the web page being converted requires authentication.
	ChromiumEnginePath	Gets or sets the full path of the directory containing the Chromium engine binaries.
	ChromiumEngineTemporaryFilesPath	Gets or sets the full path of a folder where the Chromium rendering engine will write temporary files.
	ClickElementsDelayAfter	Delay in milliseconds, after element click.
	ClickElementsDelayBefore	Delay in milliseconds, before element click.
	ClickElementsSelectors	Specifies elements from the web page that will be clicked before converting the page.
	ColorSpace	Gets or sets the color space of the generated pdf document.
	ConversionDelay	Additional time in seconds the converter waits after the web page has loaded, before it is rendered.
	CssMediaType	Indicates what css styles are used when the web page is rendered.
	CustomCSS	Use this property to specify some CSS styles that will be injected into the page that is converted.
	DenyLocalFileAccess	A flag indicating if local files can be loaded during the conversion. The default value is False and local files can be loaded.
	DisplayFooter	Controls if a custom footer is displayed in the generated pdf document.
	DisplayHeader	Controls if a custom header is displayed in the generated pdf document.
	DrawBackground	Gets or sets a flag indicating if the web page background is rendered in pdf.
	EnableOfflineMode	Puts the browser into offline mode before navigation so all network requests fail.
	ExternalLinksEnabled	Controls the rendering of external hyperlinks in pdf.
	ForceOutOfProcess	Runs this conversion in a separate engine process, whatever ChromiumEngineHostMode says.
	HttpCache	Selects what the engine's HTTP cache keeps from this conversion for the next one.
	HttpCookies	Gets the collection of custom HTTP cookies used for the conversion.
	HttpHeaders	Get the collection of custom HTTP headers used for the conversion.
	HttpPostParameters	Gets the collection of custom HTTP POST parameters used for the conversion.
	InternalLinksEnabled	Controls the conversion of internal html links to internal pdf links.
	JavaScriptEnabled	Enable scripts when rendering the url or html string.
	JpegCompressionEnabled	Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the generated pdf document.
	JpegCompressionLevel	Gets or sets the compression level of images in the generated pdf document.
	LazyImagesLoadingDelay	Delay per page, in milliseconds, for lazy images loading.
	LazyImagesLoadingEnabled	Enables a delay mechanism to allow images to fully load.
	LFN	Gets or sets the path of the diagnostic log file written during conversion. When unset, no log is written.
	LoginOptions	Handle custom page login.
	ManagedContentTrimming	Gets or sets whether the library decides where the rendered content ends on each page. Default: true.
	ManagedContentTrimmingMode	Gets or sets how the rendering engine finds where the content ends when ManagedContentTrimming is on. Default: Ink.
	MarginBottom	The bottom margin of the pdf document.
	MarginLeft	The left margin of the pdf document.
	MarginRight	The right margin of the pdf document.
	MarginTop	The top margin of the pdf document.
	MaxConversionTime	The timeout in seconds for the print phase that produces the PDF after the page has loaded.
	MaximumConcurrentConversions	Maximum number of html to pdf conversions that can be performed simultaneously.
	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.
	PageRanges	Restricts the generated PDF to a subset of pages, e.g. "1", "2-4", "1-3,5,7-".
	PdfBookmarkOptions	Gets a reference to the object that controls the bookmarks creation for the generated pdf document.
	PdfCompressionLevel	This property controls the compression level of the generated pdf document.
	PdfDocumentInformation	Gets a reference to the object that specifies the generated pdf document properties.
	PdfPageCustomSize	This property can be used to specify a custom pdf document page size.
	PdfPageOrientation	This property controls the page orientation of the generated pdf document pages.
	PdfPageSize	This property controls the size of the generated document pages.
	PdfStandard	Defines the pdf standard used by the generated pdf document.
	PostLoadingScript	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.
	PostLoadingScriptDelayAfter	Delay in milliseconds, after post page loading javascript injection.
	ProxyOptions	Gets a reference to an object containing the proxy settings used to access the web page that is being converted.
	RenderingEngine	Gets or sets the rendering engine used by the converter to load and render the HTML. Chromium binaries must be also installed using a different package.
	RenderPageOnTimeout	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.
	SecurityOptions	Gets a reference to the object that specifies the generated pdf document security settings.
	ViewerPreferences	Controls how the pdf document will appear in a pdf viewer (like Adobe Reader).
	WebGlEnabled	Controls WebGL support in the rendering engine.
	WebPageFixedSize	Controls whether the content below WebPageHeight is left out of the generated pdf document.
	WebPageHeight	Gets or sets the height of the converted web page as it would appear in the internal browser used to render the html.
	WebPageWidth	Gets or sets the width of the converted web page as it would appear in the internal browser used to render the html.
	WindowStatus	If set, the converter waits for window.status to equal this value before capturing the page.

Top

Remarks

The HtmlToPdf class defines a reference to an object of this type, exposed as Options. Configure it before calling one of the converter's convert methods.

Example

Copy

HtmlToPdf converter = new HtmlToPdf();
converter.Options.PdfPageSize = PdfPageSize.A4;
converter.Options.PdfPageOrientation = PdfPageOrientation.Portrait;
converter.Options.MarginLeft = 20;
converter.Options.WebPageWidth = 1024;
PdfDocument doc = converter.ConvertUrl("https://www.google.com");
doc.Save("out.pdf");
doc.Close();

Dim converter As New HtmlToPdf()
converter.Options.PdfPageSize = PdfPageSize.A4
converter.Options.PdfPageOrientation = PdfPageOrientation.Portrait
converter.Options.MarginLeft = 20
converter.Options.WebPageWidth = 1024
Dim doc As PdfDocument = converter.ConvertUrl("https://www.google.com")
doc.Save("out.pdf")
doc.Close()

Reference

SelectPdf.Universal Namespace