Click or drag to resize
Pdf Library for .NET
HtmlToPdfOptions Class
This class contains various options used for the html to pdf conversion.
Inheritance Hierarchy
SystemObject
  SelectPdfHtmlToPdfOptions

Namespace: SelectPdf
Assembly: Select.Pdf (in Select.Pdf.dll) Version: 17.1
Syntax
public class HtmlToPdfOptions

The HtmlToPdfOptions type exposes the following members.

Constructors
  NameDescription
Public methodHtmlToPdfOptions
Top
Properties
  NameDescription
Public propertyAuthentication
Handles authentication options if the web page being converted requires authentication.
Public propertyAutoFitHeight
Specifies the html content vertical auto fit mode.
Public propertyAutoFitWidth
Specifies the html content horizontal auto fit mode.
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 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 propertyExternalLinksEnabled
Controls the rendering of external hyperlinks in pdf.
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 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 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 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 propertyProxyOptions
Gets a reference to an object containing the proxy settings used to access the web page that is being converted.
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 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 propertyWebPageFixedSize
Controls whether the web page is rendered with a fixed size internal browser or the size automatically extends to make the whole content visible.
Public propertyWebPageHeight
Gets or sets the height of the converted web page as it would appear in the internal browser used to render the html.
Public propertyWebPageWidth
Gets or sets the width of the converted web page as it would appear in the internal browser used to render the html.
Top
Remarks
The HtmlToPdf class defines a reference to an object of this type.
See Also