Click or drag to resize
Pdf Library for .NET

HtmlToPdfOptions Properties

The HtmlToPdfOptions type exposes the following members.

Properties
 NameDescription
Public propertyAllowContentHeightResize A flag used only by WebKitRestricted, Blink or Chromium engines 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.
Public propertyAuthentication Handles authentication options if the web page being converted requires authentication.
Public propertyAutoFitHeightSpecifies the html content vertical auto fit mode.
Public propertyAutoFitWidthSpecifies the html content horizontal auto fit mode.
Public propertyBlinkEngineLaunchMaxTries Blink engine process launch tries.
Public propertyBlinkEngineLaunchTimeout Blink engine process launch timeout.
Public propertyBlinkEnginePath Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries.
Public propertyBlinkEngineTemporaryFilesPath Gets or sets the full path of a folder where Blink html rendering engine will write temporary files.
Public propertyCefEnginePath Gets or sets the full path of the directory containing the SelectPdf.Cef.exe binary.
Public propertyCefEngineTemporaryFilesPath Gets or sets the full path of a folder where the CEF rendering engine will write temporary files.
Public propertyClickElementsDelayAfter Delay in miliseconds, after element click.
Public propertyClickElementsDelayBefore Delay in miliseconds, before element click.
Public propertyClickElementsSelectors Specifies elements from the web page that will be clicked before converting the page.
Public propertyColorSpace Gets or sets the color space of the generated pdf document.
Public propertyCssMediaType Indicates what css styles are used when the web page is rendered.
Public propertyCustomCSS Use this property to specify some CSS styles that will be injected into the page that is converted.
Public propertyDemoMode Enables demo mode.
Public propertyDenyLocalFileAccess A flag indicating if local files can be loaded during the conversion. The default value is False and local files can be loaded.
Public propertyDisplayCutText Gets or sets a flag indicating if the text that is out of the calculated rendering rectangle is displayed or not.
Public propertyDisplayFooter Controls if a custom footer is displayed in the generated pdf document.
Public propertyDisplayHeader Controls if a custom header is displayed in the generated pdf document.
Public propertyDrawBackground Gets or sets a flag indicating if the web page background is rendered in pdf.
Public propertyEmbedFonts Instructs the converter to embed all the needed fonts into the pdf document or not.
Public propertyEnableOfflineMode Put the browser into offline mode before navigation, so all network requests fail. Useful for testing offline fallbacks or blocking all external fetches from cached content.
Public propertyExternalBrowserEndpoint External browser service.
Public propertyExternalLinksEnabled Controls the rendering of external hyperlinks in pdf.
Public propertyGenerateSinglePagePdf Generate a single page PDF. The converter will automatically resize the PDF page to fit all the content in a single page.
Public propertyHiddenWebElements Gets a reference to the object that controls the visibility of some web elements in the generated pdf document.
Public propertyHttpCookies Gets the collection of custom HTTP cookies used for the conversion.
Public propertyHttpHeaders Get the collection of custom HTTP headers used for the conversion.
Public propertyHttpPostParameters Gets the collection of custom HTTP POST parameters used for the conversion.
Public propertyInternalLinksEnabled Controls the conversion of internal html links to internal pdf links.
Public propertyJavaScriptEnabled Enable scripts when rendering the url or html string.
Public propertyJpegCompressionEnabled Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the generated pdf document.
Public propertyJpegCompressionLevel Gets or sets the compression level of images in the generated pdf document.
Public propertyKeepImagesTogether This property instructs the converter whether to try to avoid cutting off the images between pdf pages or not.
Public propertyKeepTextsTogether This property instructs the converter whether to try to avoid cutting off the text lines between pdf pages or not.
Public propertyLazyImagesLoadingDelay Delay per page, in miliseconds, for lazy images loading.
Public propertyLazyImagesLoadingEnabled Enables a delay mechanism to allow images to fully load.
Public propertyLFN Internal use only.
Public propertyLFNB Internal use only.
Public propertyLoginOptions Handle custom page login.
Public propertyMarginBottom The bottom margin of the pdf document.
Public propertyMarginLeft The left margin of the pdf document.
Public propertyMarginRight The right margin of the pdf document.
Public propertyMarginTop The top margin of the pdf document.
Public propertyMaxConversionTime Timeout in seconds for the print / capture phase (producing the PDF after the page has loaded). Applies to the Chromium rendering engine only.
Public propertyStatic memberMaximumConcurrentConversions Maximum number of html to pdf conversions that can be performed simultaneously.
Public propertyMaxPageLoadTime The web page navigation timeout in seconds.
Public propertyMinPageLoadTime An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered.
Public propertyPageBreaksEnhancedAlgorithm Gets or sets a flag indicating if an enhanced custom page breaks algorithm is used. The enhanced algorithm is a little bit slower but it will prevent the appearance of hidden text in the PDF when custom page breaks are used.
Public propertyPageRanges Restrict the generated PDF to a subset of pages, e.g. "1", "2-4", "1-3,5,7-".
Public propertyPdfBookmarkOptions Gets a reference to the object that controls the bookmarks creation for the generated pdf document.
Public propertyPdfCompressionLevel This property controls the compression level of the generated pdf document.
Public propertyPdfDocumentInformation Gets a reference to the object that specifies the generated pdf document properties.
Public propertyPdfPageCustomSize This property can be used to specify a custom pdf document page size.
Public propertyPdfPageOrientation This property controls the page orientation of the generated pdf document pages.
Public propertyPdfPageSize This property controls the size of the generated document pages.
Public propertyPdfStandard Defines the pdf standard used by the generated pdf document.
Public propertyPluginsEnabled A flag indicating if plugins (like Flash players) are enabled in the converter.
Public propertyPostLoadingScript 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.
Public propertyPostLoadingScriptDelayAfter Delay in miliseconds, after post page loading javascript injection.
Public propertyProxyOptions Gets a reference to an object containing the proxy settings used to access the web page that is being converted.
Public propertyRenderingEngine Gets or sets the rendering engine used by the converter to load and render the HTML. The possible values are WebKit, WebKitRestricted and Blink. The Webkit rendering engine is internal and renders similar to Apple's Safari. For Blink, Chromium binaries must be also installed.
Public propertyRenderPageOnTimeout 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.
Public propertyScaleImages A flag indicating if the images from the page are scaled during the conversion process. The default value is False and images are not scaled.
Public propertySecureProtocol Protocol used for secure (HTTPS) connections.
Public propertySecurityOptions Gets a reference to the object that specifies the generated pdf document security settings.
Public propertyStartupMode Use this property to specify how the conversion starts.
Public propertyStartupScript Use this property to specify some JavaScript code that will be injected into the page that is converted.
Public propertyViewerPreferences Controls how the pdf document will appear in a pdf viewer (like Adobe Reader).
Public propertyVisibleWebElementId Use this property to convert only a certain section of the page, specified by the html element ID.
Public propertyWebElementsMappingOptions 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 CssSelectors property of WebElementsMappingOptions must be set with an array of strings containing the selectors of the HTML elements. The positions of the HTML elements in the generated PDF document will be returned in the Result object.
Public propertyWebPageFixedSizeControls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible.
Public propertyWebPageHeightGets or sets the height of the converted web page as it would appear in the internal browser used to render the html.
Public propertyWebPageWidthGets or sets the width of the converted web page as it would appear in the internal browser used to render the html.
Public propertyWindowStatus If set, the converter waits for window.status to match this string before capturing the page. Useful for pages that signal readiness via the classic window.status = "ready" handshake.
Top
See Also