PdfConverter Properties

Add a padding at the end of the generated PDF document. By default this property is false.

There are situations when a fraction of the right and bottom borders of an image or table cell are overwritten by the image content or table cell background when the PDF document is viewed with Adobe Reader. The AdjustBorderSize value is subtracted from the background width and height. The default value is 0 points.

A flag indicating if local files can be loaded during the conversion. The default value is True and local files can be loaded.

Enables or disables alpha blending for transparent images. Default is true.

Optionally set this object Username and Password properties to authenticate to the web server before accessing the URL to be converted (e.g handles Integrated Windows Authentication with IIS).

When true this property instructs the converter to try to avoid cutting off the images between PDF pages. By default this property is false.

When true this property instructs the converter to try to avoid cutting off the text between PDF pages. By default this property is true. This property has effect only when generating a PDF with selectable text (PdfDocumentOptions.GenerateSelectablePdf is true).

Set this true when using the converter for batch conversion. By default this property is false.

Enable behaviors when rendering HTML to PDF. By default this property is false.

Enable binary behaviors when rendering HTML to PDF. By default this property is false.

Modify background transparency. 0 means transparent, 100 means opaque.

Gets or sets the full path (excluding the chrome.exe file name) of the Blink html rendering engine binaries.

Gets or sets the full path of a folder where Blink html rendering engine will write temporary files.

Use this property to enable caching of web requests. Sets the full path of the local cache folder. Note: This is used only by the WebKit rendering engine.

Delay in miliseconds, after element click.

Delay in miliseconds, before element click.

Specifies elements from the web page that will be clicked before converting the page.

If the HTML content is not entirely visible in the HTML viewer at the specified width, the ClipHtmlView property will control whether the HTML content is clipped or the HTML viewer width is automatically extended to make visible the whole HTML content. The HTML viewer width is given by the PageWidth property. The default value of this property is false. Note: This is used only by the WebKit rendering engine.

Gets or sets the color space of the generated PDF document. The possible values are RGB, CMYK or Gray Scale. The default color space is RGB.

An additional time in seconds to wait for asynchronous items to be loaded. A delay is necessary for example to allow a Flash movie to start before starting conversion.

Offers summary information about the conversion process. After a successfull conversion this property is initialized with an instance of the ConversionSummary class. If the conversion failed this property returns a null value.

Use this property to specify some CSS styles that will be injected into the page that is converted.

Gets or sets a flag indicating if the HTML page background is rendered in PDF. Default value is true. Setting this property to false can make visible the existing PDF content behind this element.

Internal use only.

Internal use.

External browser service.

Internal use only.

Use this property to specify the path where temporary font files are saved. If this is not specified, the system temporary folder is used. Note: This is used only by the WebKit rendering engine.

Gets an object populated after conversion with the title, keywords, and description of the converted HTML document. This information can be used for example in the PostConvertActionEvent handler to set the corresponding fields of the PdfDocumentInfo object.

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 HtmlElementIds and HtmlTagNames properties of HtmlElementsMappingOptions must be set with an array of strings containing the HTML IDs and tag names of the HTML elements. The positions of the HTML elements in the generated PDF document will be returned in the HtmlElementsMappingResult object.

Gets a reference to the object controlling the exclusion of HTML elements from rendering to PDF. In order to exclude from PDF for a list of HTML elements, the HtmlElementIds and HtmlTagNames properties of HtmlExcludedRegionsOptions must be set with an array of strings containing the HTML IDs or tag names of the HTML elements excluded from conversion to PDF.

Gets a collection of custom HTTP cookies to be sent by the converter to the web server when the web page to convert and the resources (image, css, etc) referenced by the web page are requested. A cookie is defined by a name and a value pair that can be added to the collection using the Add(string, string) method of the HttpCookies property. Note: This is used only by the WebKit rendering engine.

Gets a collection of custom HTTP headers to be sent by the converter to the web server when the web page is requested from a URL. A custom HTTP header is defined by a name and a value pair that can be added to the collection using the Add(string, string) method of the HttpHeaders property. The custom HTTP headers can be used to define cookies, authentication options, URL referer or any other HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpCookies property. Note: This is used only by the WebKit rendering engine.

Modify images transparency. 0 means transparent, 100 means opaque.

Sets the full path of the helper file. Note: This is used only by the WebKit rendering engine.

Specifies the internet security zone settings used by the HTML converter to convert web sites. LocalMachine security zone offers most of the rights during conversion.

This static parameter gives the maximum time in seconds necessary to layout a HTML document. The default value is 10 minutes.

Delay per page, in miliseconds, for lazy images loading.

Enables a delay mechanism to allow images to fully load.

Gets or sets the license key string received from the vendor. If this property is null the converter will automatically enter in evaluation mode and a demo watermark is displayed on the generated PDF document.

This static parameter gives the maximum number of threads in the current process that can download and execute HTML documents simultaneously. This parameter must be set before the first conversion performed in the current process. When this parameter is 0 or negative and SerializeLoadHtml is false the concurrency level is the maximum value.

Handle custom page login.

Enables or disables masking for transparent images. Default is true.

The navigation timeout in seconds. Default value is 60. You can increase this timeout is you have a very slow network or when you convert a very big file.

When this property is true the library will try to release the unused memory as soon as possible. The default value is false.

A flag indicating if the converter uses an optimized page breaks algorithm to improve document scrolling inside a PDF Viewer. The optimized algorithm can introduce a small additional processing time when the PDF document is generated.

Gets or sets the height of the HTML document in pixels. The HTML document will be truncated if its height exceeds the specified value of this property. If this parameter is set to 0 or a negative value, the whole HTML document will be converted to PDF. Because all the dimensions in the PDF document are measured in points (1 point is 1/72 inch), it might be necessary to transform pixels to points and points to pixels using the UnitsConverter class in order to better control the HTML to PDF conversion.

Gets or sets the width of the HTML document in pixels. The default width is 1024 pixels and this value can be changed by setting this property or by specifying the htmlDocWidthPx parameter in the constructor. If this property is set to 0 or a to negative value, the width of the HTML document will be automatically calculated. Because all the dimensions in the PDF document are measured in points (1 point is 1/72 inch), it might be necessary to transform pixels to points and points to pixels using the UnitsConverter class in order to better control the HTML to PDF conversion.

Gets a reference to the object controlling the bookmarks creation for the rendered PDF document. In order to enable creation of bookmarks you have to set the TagNames property of PdfBookmarkOptions with the names of the HTML tags you want to bookmark.

This static parameter gives the maximum number of threads in the current .NET application domain that can convert HTML to PDF simultaneously. This parameter must be set before the first conversion performed in the current application domain. When this property is set with a negative value or zero the concurrency level is maximum. The default value is 4.

Gets a reference to the object to controlling the generated PDF document information like the document title, author, subject or creation date.

Gets a reference to the object controlling the conversion process and the generated PDF document properties. This property can be used to control the PDF document margins, PDF compression level, JPEG compression level, the PDF page size and orientation, the PDF document headers and footers, conversion of the URLs to links in PDF, conversion of the HTML links with anchors to internal PDF links, true type fonts embedding, fit width and stretch to fit, conversion to a single PDF page, append or prepend external PDF documents.

Gets a reference to an object to control the generated PDF document footer options. The footer is displayed in the generated PDF document if the PdfDocumentOptions.ShowFooter property is true.

Gets a reference to an object to control the generated PDF document header options. The header is displayed in the generated PDF document if the PdfDocumentOptions.ShowHeader property is true.

Gets a reference to the object to controlling the generated PDF document security settings like user and owner password, restrict printing or editing of the generated PDF document.

Defines the PDF subset used by the generated PDF. The default value is Full. This property can be used to instruct the converter to generate PDF/A, PDF/X or PDF/SiqQ compliant documents.

Gets a reference to the object controlling how the generated PDF is displayed by the PDF viewer.

A flag indicating if plugins are enabled in converter. The default is true. Note: This is used only by the WebKit rendering engine.

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.

Delay in miliseconds, after post page loading javascript injection.

Gets a reference to an object encapsulating the proxy options used to access the HTML document to convert. Note: This is used only by the WebKit rendering engine.

Use this property to convert only a certain section of the page, specified by the html element ID. Note: This is used only by the WebKit rendering engine.

Gets or sets the rendering engine used by the converter to load and render the html. The possible values are WebKit and IE. The Webkit rendering engine is internal and renders similar to Chrome and Safari. For IE, the component uses the IE engine from the machine.

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. Note: This is used only by the WebKit rendering engine.

A flag indicating if the images from the web page can be resized to optimize memory usage. Note: This is used only by the WebKit rendering engine.

This property is obsolete. Setting this property is not necessary anymore when converting pages in right-to-left languages like Hebrew or Arabic.

Internal use only.

Internal use only.

Internal use only.

Enable scripts (JavaScript) when converting HTML to a PDF with selectable text. By default this property is true. This property has effect only when generating a PDF with selectable text (PdfDocumentOptions.GenerateSelectablePdf is true).

Enable scripts (JavaScript) when converting HTML to a PDF with embedded image. By default this property is true. This property has effect only when generating a PDF with embedded image. (PdfDocumentOptions.GenerateSelectablePdf is false).

This static flag indicates if the download and execution of the HTML code is serialized when the converter is called simultaneously from multiple threads of an application. This parameter must be set before the first conversion performed in the current process. Default value is false.

Internal use.

Use this property to specify the converter startup mode. By default this is set to Automatic and the conversion is started as soon as the page loads (and ConversionDelay elapses). If set to Manual, the conversion is started only by a javascript call to ExpertPdfJSObj.startConversion() Note: This is used only by the WebKit rendering engine.

Use this property to specify some JavaScript code that will be injected into the page that is converted. The JavaScript code specified here will run before any other script on the page. Note: This is used only by the WebKit rendering engine.

Gets or sets a flag indicating if the transparency is enabled in the generated PDF document. Default value is true. This property can be set to false to eliminate the additional flattening time when the document is sent to the printer from Adobe Reader viewer.

Internal use only.

When this property is true, the generated PDF will store the PDF cross-reference table and PDF trailer in compressed cross-reference streams and therefore the generated PDF document will be smaller in size. Set this false for compatibility with third party tools unable to understand the cross-reference streams. The default value is false.

Use this property to specify if the web fonts are kept in memory or on the disk in a temporary file. Note: This is used only by the WebKit rendering engine.

A flag indicating if texts are rendered using glyphs or regular characters. The default is false and regular characters are used if possible. Glyphs are forced for special languages (such as right to left or Asian). Note: This is used only by the WebKit rendering engine.

A flag indicating if @media print css styles are used or not. The default is false and @media screen css styles are used. Note: This is used only by the WebKit rendering engine.

Internal use only