 | |
HtmlToPdfOptions Properties | |
The HtmlToPdfOptions type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowContentHeightResize |
A flag used only by WebKitRestricted engine 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.
|
| AutoFitHeight | Specifies the html content vertical auto fit mode. |
| AutoFitWidth | Specifies the html content horizontal auto fit mode. |
| BlinkEnginePath |
Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries.
|
| BlinkEngineTemporaryFilesPath |
Gets or sets the full path of a folder where Blink html rendering engine will write temporary files.
|
| ClickElementsDelayAfter |
Delay in miliseconds, after element click.
|
| ClickElementsDelayBefore |
Delay in miliseconds, 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.
|
| 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.
|
| DisplayCutText |
Gets or sets a flag indicating if the text that is out of the calculated rendering rectangle is displayed or not.
|
| 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.
|
| EmbedFonts |
Instructs the converter to embed all the needed fonts into the pdf document or not.
|
| ExternalBrowserEndpoint |
External browser service.
|
| ExternalLinksEnabled |
Controls the rendering of external hyperlinks in pdf.
|
| GenerateSinglePagePdf |
Generate a single page PDF. The converter will automatically resize the PDF page to fit all the content in a single page.
|
| HiddenWebElements |
Gets a reference to the object that controls the visibility of some web elements in the generated pdf document.
|
| 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.
|
| KeepImagesTogether |
This property instructs the converter whether to try to avoid cutting off the images between pdf pages or not.
|
| KeepTextsTogether |
This property instructs the converter whether to try to avoid cutting off the text lines between pdf pages or not.
|
| LazyImagesLoadingDelay |
Delay per page, in miliseconds, for lazy images loading.
|
| LazyImagesLoadingEnabled |
Enables a delay mechanism to allow images to fully load.
|
| LFN |
Internal use only.
|
| LoginOptions |
Handle custom page login.
|
| 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.
|
 | MaximumConcurrentConversions |
Maximum number of html to pdf conversions that can be performed simultaneously.
|
| MaxPageLoadTime |
The web page navigation timeout in seconds.
|
| MinPageLoadTime |
An additional time in seconds to wait for asynchronous items to be loaded before the web page is rendered.
|
| PageBreaksEnhancedAlgorithm |
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.
|
| 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.
|
| PluginsEnabled |
A flag indicating if plugins (like Flash players) are enabled in the converter.
|
| 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 miliseconds, 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. 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.
|
| 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.
|
| ScaleImages |
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.
|
| SecureProtocol |
Protocol used for secure (HTTPS) connections.
|
| SecurityOptions |
Gets a reference to the object that specifies the generated pdf document security settings.
|
| StartupMode |
Use this property to specify how the conversion starts.
|
| StartupScript |
Use this property to specify some JavaScript code that will be injected into the page that is converted.
|
| ViewerPreferences |
Controls how the pdf document will appear in a pdf viewer (like Adobe Reader).
|
| VisibleWebElementId |
Use this property to convert only a certain section of the page, specified by the html element ID.
|
| WebElementsMappingOptions |
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.
|
| WebPageFixedSize | Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible. |
| 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. |
See Also