PdfHtmlSection Class


PdfHtmlSection Class

Represents a html element that can be added to the header or footer templates of a pdf document.

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfSectionElement
SelectPdf.UniversalPdfHtmlSection

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

Syntax

Copy

public class PdfHtmlSection : PdfSectionElement

Public Class PdfHtmlSection
	Inherits PdfSectionElement

The PdfHtmlSection type exposes the following members.

Constructors

	Name	Description
	PdfHtmlSection(String)	Creates a html section object from a url that can be added to the header or footer templates of a pdf document.
	PdfHtmlSection(String, String)	Creates a html section object from html string content that can be added to the header or footer templates of a pdf document.
	PdfHtmlSection(Single, Single, String)	Creates a html section object from a url that can be added to the header or footer templates of a pdf document.
	PdfHtmlSection(Single, Single, Single, String)	Creates a html section object from a url that can be added to the header or footer templates of a pdf document.
	PdfHtmlSection(Single, Single, String, String)	Creates a html section object from html string content that can be added to the header or footer templates of a pdf document.
	PdfHtmlSection(Single, Single, Single, String, String)	Creates a html section object from html string content that can be added to the header or footer templates of a pdf document.

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	HTTP authentication credentials used when fetching the web page.
	BaseUrl	Gets or sets the base url used to resolve relative paths in the html string.
	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 in milliseconds after each element click. Default: 200.
	ClickElementsDelayBefore	Delay in milliseconds before each element click. Default: 20.
	ClickElementsSelectors	Css selectors of elements to click before rendering. Useful for dismissing banners or expanding collapsed sections.
	ConsoleLog	The text written to the browser console by the converted web page during rendering. Populated after the section has been rendered.
	ConversionDelay	Additional time in seconds the converter waits after the web page has loaded, before it is rendered.
	CssMediaType	Css media type used when rendering the html. Default: Screen.
	CustomCSS	Custom css injected into the page before rendering.
	DenyLocalFileAccess	Deny local file access during conversion. Default: false.
	DrawBackground	Render the web page background. Default: true.
	EnableOfflineMode	Puts the browser into offline mode before navigation so all network requests fail. Default: False.
	ExternalLinksEnabled	Render external hyperlinks from the web page. Default: true.
	ForceOutOfProcess	Runs this section's rendering in a separate engine process, whatever ChromiumEngineHostMode says.
	Height	Gets or sets the element height, in points, in the destination pdf page. (Inherited from PdfSectionElement)
	HiddenWebElements	Gets a reference to the object that controls the visibility of some web elements in the section.
	HtmlString	Gets or sets the html string content to render in the header or footer.
	HttpCache	Selects what the engine's HTTP cache keeps from this conversion for the next one.
	HttpCookies	Custom HTTP cookies sent when fetching the web page.
	HttpHeaders	Custom HTTP headers sent when fetching the web page.
	HttpPostParameters	Custom HTTP POST parameters sent when fetching the web page.
	InternalLinksEnabled	Convert internal (anchor) hyperlinks into internal pdf links. Default: true.
	JavaScriptEnabled	Run javascript when rendering the html. Default: true.
	LazyImagesLoadingDelay	If LazyImagesLoadingEnabled is set to True, this property specifies the delay inserted for each rendered page. Default: 40.
	LazyImagesLoadingEnabled	A flag indicating if the lazy loaded images are rendered in the generated content. Default: True.
	LFN	Path of the diagnostic log file written during conversion. When unset, no log is written.
	LoginOptions	Custom-page login options used to authenticate before rendering.
	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.
	MaxConversionTime	Timeout in seconds for the print phase that produces the rendered header/footer content. 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.
	PageRanges	Restricts the rendered content to a subset of pages, e.g. "1", "2-4". Empty means all pages.
	PostLoadingScript	Javascript code injected and executed after the page has fully loaded.
	PostLoadingScriptDelayAfter	Delay in milliseconds after post-loading script injection. Default: 20.
	ProxyOptions	Network proxy options used when fetching the web page.
	RenderingEngine	Gets or sets the rendering engine used to load and render the html.
	RenderPageOnTimeout	Render the page on timeout instead of throwing. Default: false.
	StartupMode	Controls when the conversion starts rendering the page.
	StartupScript	Javascript executed when StartupMode is Manual.
	Tagged	Gets or sets a flag indicating if the rendered html of the section is tagged (produces an accessible logical structure). The default value is false.
	Url	Gets or sets the url of the html page to render in the header or footer.
	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	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.
	Width	Gets or sets the element width, in points, in the destination pdf page. (Inherited from PdfSectionElement)
	WindowStatus	If set, the converter waits for window.status to equal this value before capturing the page. Empty disables the wait.
	X	Gets or sets the element position on the X axis. (Inherited from PdfSectionElement)
	Y	Gets or sets the element position on the Y axis. (Inherited from PdfSectionElement)

Top

Remarks

The html can be specified by either an url or a html string. The html is rendered once using an internal HtmlToPdf conversion at the destination rectangle size and the resulting first page is drawn onto the header/footer of every page.

Example

Copy

HtmlToPdf converter = new HtmlToPdf();
converter.Options.DisplayHeader = true;
PdfHtmlSection html = new PdfHtmlSection(0, 0, "<b>My header</b>", "");
converter.Header.Add(html);
PdfDocument doc = converter.ConvertUrl("https://www.google.com");
doc.Save("out.pdf");
doc.Close();

Dim converter As New HtmlToPdf()
converter.Options.DisplayHeader = True
Dim html As New PdfHtmlSection(0, 0, "<b>My header</b>", "")
converter.Header.Add(html)
Dim doc As PdfDocument = converter.ConvertUrl("https://www.google.com")
doc.Save("out.pdf")
doc.Close()

Reference

SelectPdf.Universal Namespace