This class is the main class of the HTML to PDF Converter which offers the necessary methods to create a PDF document from
a web page at given URL or from a HTML string. The generated PDF document can be saved into a memory buffer or into a file
Inheritance Hierarchy
WinnovativeHtmlToPdfConverter
WinnovativePdfConverter
Namespace: Winnovative
Assembly: wnvhtmltopdf (in wnvhtmltopdf.dll) Version: 17.0.0.0
Syntax
The HtmlToPdfConverter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | HtmlToPdfConverter |
Creates a HTML to PDF converter using the default width and height for the HTML viewer window.
The default HTML viewer width is 1024 pixels and the default HTML viewer height is 0 which means
the HTML viewer height will be automatically determined based on the HTML content and the HTML viewer width in order to
make visible the whole HTML content.
If the HTML content is not entirely visible in the HTML viewer at the default width of 1024 pixels, the ClipHtmlView property will control whether
the HTML content is clipped to the width set for the HTML viewer or the HTML viewer width is automatically extended to make visible the whole HTML content.
By default the ClipHtmlView property is false and the HTML viewer is automatically extended in width to make visible the whole HTML content.
The width and height of the HTML viewer can also be controlled by the HtmlViewerWidth and HtmlViewerHeight properties
of the HtmlToPdfConverter class.
|
| HtmlToPdfConverter(Int32) |
Creates a HTML to PDF converter using the specified width in pixels and the default height for the HTML viewer window.
The default HTML viewer height is 0 which means the HTML viewer height will be automatically determined
based on the HTML content and the HTML viewer width in order to make visible the whole HTML content.
If the 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.
By default the ClipHtmlView property is false and the HTML viewer is automatically extended in width to make visible the whole HTML content.
The width and height of the HTML viewer can also be controlled by the HtmlViewerWidth and HtmlViewerHeight properties
of the HtmlToPdfConverter class.
|
| HtmlToPdfConverter(Int32, Int32) |
Creates a HTML to PDF using the specified width and height in pixels for the HTML viewer window.
If the specified HTML viewer height is 0 the HTML viewer height will be automatically determined based on the HTML content and the HTML viewer width
in order to make visible the whole HTML content.
If the 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.
By default the ClipHtmlView property is false and the HTML viewer is automatically extended in width to make visible the whole HTML content.
The width and height of the HTML viewer can also be controlled by the HtmlViewerWidth and HtmlViewerHeight properties
of the HtmlToPdfConverter class
|
Properties
| Name | Description | |
|---|---|---|
 | AuthenticationOptions |
This property can be set with an username and a password in order to authenticate to the web server
before accessing the URL to be converted in HTML to PDF Converter. They can be used for example to resolve the IIS Integrated Windows Authentication
or other types of IIS authentication.
|
| ClipHtmlView |
If the HTML content is not entirely visible in the HTML viewer of the HTML to PDF converter at the specified width, this 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 HtmlViewerWidth property.
The default value of this property is false.
|
| ConversionDelay |
An additional time in seconds to wait for asynchronous items to be completely loaded or for a web page redirect to finish before
starting the rendering in HTML to PDF converter. Default value is 2.
|
| ConversionSummary |
Offers summary information about the conversion process. After a successful conversion this
property is initialized with an instance of the ConversionSummary class. If the conversion
failed this property returns a null value.
|
| DefaultHtmlEncoding |
The default HTML document text encoding to be used if there is no charset meta tag defined in the HTML document. By default this property is not set
and an auto determined text encoding will be used by converter
|
| DownloadAllResources |
Gets or sets a flag indicating if the HTML to PDF converter should try to download all the resources even if this could cause
a slower conversion. The default value is false.
|
| Enable3DTransformations |
Gets or sets a flag indicating if the accelerated CSS 3D transformations are enabled in the HTML to PDF converter. The default value is false
|
| EnableAccelerated2DCanvas |
Gets or sets a flag indicating if the accelerated 2D canvas is enabled in the HTML to PDF converter. The default value is false
|
| EnableHttp2 |
Gets or sets a flag indicating if the HTTP2 protocol is enabled in HTML to PDF converter.
The property has effect only in NE version of the library. The default value is false
|
| EnablePersistentStorage |
Gets or sets a flag indicating if the persistent local storage is enabled in the HTML to PDF converter. The default value is false
|
| EnableWebGL |
Gets or sets a flag indicating if the WebGL is enabled in the HTML to PDF converter. The default value is false
|
| ExtensionsEnabled |
Gets or sets a flag indicating if the HTML viewer extensions are executed during HTML to PDF conversion. The default value is false and no extension is executed.
The Flash player for Mozilla Firefox must be installed in order to execute the flash content from HTML
|
| HiddenHtmlElementsSelectors |
Gets or sets the CSS selectors of the HTML elements to be excluded from rendering during HTML to PDF conversion
|
| HtmlDocumentInfo |
Gets an object populated after conversion with the title, keywords, and description of the converted HTML document.
|
| HtmlElementsMappingOptions |
Gets a reference to the object that can be used to obtain the position in PDF of the HTML elements rendered by the HTML to PDF converter.
In order to retrieve the position in PDF for a list of HTML elements, the HtmlElementSelectors property of
HtmlElementsMappingOptions class must be set with an array of strings containing the CSS selectors of the HTML elements you want to map.
The positions of the HTML elements in the generated PDF document will be returned in the
HtmlElementsMappingResult object after the element was added to the page.
|
| HtmlViewerHeight |
Gets or sets the HTML viewer height in pixels in the HTML to PDF Converter .
If the specified HTML viewer height is 0 the HTML viewer height will be automatically determined based on the HTML content and
the HTML viewer width in order to make visible the whole HTML content.
The HTML viewer width is given by the HtmlViewerWidth property of the HtmlToPdfConverter class.
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 height can also be specified in the HtmlToPdfConverter class contructor. The default value is 0 to automatically determine
the HTML viewer height based on the HTML content and the HTML viewer width.
|
| HtmlViewerWidth |
Gets or sets the preferred HTML viewer width in pixels in HTML to PDF converter.
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.
By default the ClipHtmlView property is false and the HTML viewer is automatically extended in width to make visible the whole HTML content.
The HTML viewer width can also be specified in the HtmlToPdfConverter class constructor. The default value is 1024 pixels.
|
| HtmlViewerZoom |
Gets or sets the HTML viewer zoom percentage in HTML to PDF Converter similar to zoom level in a browser.
The default value of this property is 100
|
| HttpPostFields |
Returns the collection of HTTP POST fields to be used when accessing a web page in HTML to PDF converter.
If there are elements in collection then the converter will make a POST request to the web page URL
with the fields from this collection, otherwise it will make a GET request
|
| HttpRequestCookies |
Gets a collection of custom HTTP cookies to be sent by the HTML to PDF 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 HttpRequestCookies property.
|
| HttpRequestHeaders |
Gets a collection of custom HTTP headers to be sent by the HTML to PDF 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 HttpRequestHeaders property.
The PersistentHttpRequestHeaders property can be set on true to instruct the converter to send the custom headers
each time an external resource (image, css, etc) referenced by the web page is requested. By default the PersistentHttpRequestHeaders
property is false and the custom headers are not automatically sent to the web server when the web page resources are requested.
The custom HTTP headers can be used to define cookies, authentication options, URL referrer or any other
HTTP header to be sent to the web browser. The preferred method to send cookies is to use the HttpRequestCookies property.
|
| ImagePartSize |
Gets or sets the maximum height in pixels of an image part in HTML to PDF converter
|
| ImpersonationOptions |
The impersonation options applied during navigation in HTML to PDF converter
|
| InitialHtmlViewerHeight |
Gets or sets the initial height in pixels of the HTML viewer in HTML to PDF converter.
This value of this property is ignored if the HtmlViewerHeight property is set
|
| InterruptSlowJavaScript |
Gets or sets a flag indicating if the slow JavaScript script should be interrupted in HTML to PDF converter. The default value is false and the scripts are not interrupted
|
| JavaScriptEnabled |
A flag indicating if JavaScript execution is enabled in HTML to PDF converter.
The default is true.
|
| LicenseKey |
Gets or sets the license key string received from the vendor in HTML to PDF converter.
If this property is null the converter will automatically enter in evaluation mode
and a demo watermark will be displayed on the generated PDF document.
|
| LocalFilesAccessEnabled |
Gets or sets a flag indicating if the access to local files is enabled in the HTML to PDF converter. The default value is true
|
| ManualTriggeringConversionDelay |
An additional time in seconds to wait after manual triggering before
starting the rendering in HTML to PDF converter. Default value is 2.
|
| MaxHtmlViewerHeight |
Gets or sets the maximum height in pixels to be rendered from the HTML document by the HTML to PDF converter.
The default value is 0 and the entire HTML document is rendered
|
| MediaType |
Gets or sets the media type of the HTML document used by the HTML to PDF converter. The default media type is 'screen'.
If you set this property with 'print' then the CSS properties defined in '@media print' rule will be used to render the document
|
| MinHtmlViewerHeight |
Gets or sets the minimum height in pixels to be rendered from HTML document by the HTML to PDF converter.
This value of this property is ignored if the HtmlViewerHeight property is set
|
| NavigationTimeout |
The HTML to PDF converter navigation timeout in seconds. Default value is 60.
|
| NavigatorUserAgent |
The custom user agent to be used when accessing the HTML page. When this property is null or empty the default user agent is used
|
| PdfBookmarkOptions |
Gets a reference to the object controlling the bookmarks creation for the rendered PDF document generated by the HTML to PDF converter.
In order to enable creation of bookmarks you have to set the HtmlElementSelectors property of PdfBookmarkOptions class
with the CSS selectors of the HTML elements you want to bookmark.
|
 | PdfConverterConcurrencyLevel |
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.
|
| PdfDocumentInfo |
Gets a reference to the object to controlling the generated PDF
document information like the document title, author, subject or creation date.
|
| PdfDocumentOptions |
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.
|
| PdfFooterOptions |
Gets a reference to an object to control the generated PDF document footer options.
The footer is displayed in the generated PDF document only if the ShowFooter property is true.
|
| PdfFormOptions |
Gets a reference to the object controlling the automatic conversion of a HTML form to a PDF form in the generated PDF document
|
| PdfHeaderOptions |
Gets a reference to an object to control the generated PDF document header options.
The header is displayed in the generated PDF document only if the ShowHeader property is true.
|
| PdfSecurityOptions |
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.
|
| PdfViewerPreferences |
Gets a reference to the object controlling how the generated PDF is displayed by a PDF viewer.
|
| PersistentHttpRequestHeaders |
This property can be set on true to instruct the HTML to PDF converter to send the custom headers defined by the
HttpRequestHeaders property each time an external resource (image, css, etc) referenced by the web page is requested.
The default value of this property is true and the custom headers are automatically sent to the web server when the web page resources are requested.
|
| PostScriptFontsEnabled |
Gets or sets a flag indicating if the fonts with PostScript outlines are enabled in HTML during the HTML to PDF conversion. The default value is true
|
| PrerenderEnabled |
Gets or sets a flag indicating if the HTML to PDF converter should perform a pre-rendering. The default value is false
|
| ProxyOptions |
Gets a reference to an object encapsulating the proxy options used by HTML to PDF converter to access the HTML document to convert.
|
| RenderedHtmlElementSelector |
Get or set the CSS selector of the HTML element to be rendered to PDF by the HTML to PDF converter. If the selector selects multiple HTML elements,
only the the first one will be converted. The CSS selector is case sensitive. If this property is not set then the entire
HTML document is rendered
|
| SvgFontsEnabled |
Gets or sets a flag indicating if the SVG fonts are enabled in HTML during the HTML to PDF conversion. The default value is false
|
| TableOfContentsOptions |
Gets a reference to the object controlling the automatic creation of a table of contents in the generated PDF document
|
| TriggeringMode |
The conversion triggering mode used by the HTML to PDF converter. The default value is ConversionDelay.
|
| WebFontsEnabled |
Gets or sets a flag indicating if the Web Fonts are enabled in HTML during the HTML to PDF conversion. The default value is true
|
| WnvInternalFileName |
Sets the full path of wnvinternal.dat helper file of the HTML to PDF Converter. By default this file is expected to be found
in the same folder with wnvhtmltopdf.dll assembly.
|
| XPSupplementalLanguages |
A flag in HTML to PDF converter indicating if the supplemental languages (complex script, right-to-left, East Asian) support was enabled in Windows XP Regional and Language Options. The default value is false.
|
Methods
| Name | Description | |
|---|---|---|
| ConvertHtml(String, String) |
Converts a HTML string to PDF using a base URL to resolve external resources and returns the rendered PDF document into a memory buffer
|
| ConvertHtml(String, String, String) |
Converts a HTML string to PDF using a base URL to resolve external resources and an internal links base URL and returns the rendered PDF document into a memory buffer
|
| ConvertHtmlFile |
Converts a HTML file to PDF and returns the rendered PDF document into a memory buffer
|
| ConvertHtmlFileToFile |
Converts a HTML file to PDF and writes the rendered PDF document into a file
|
| ConvertHtmlFileToPdfDocumentObject |
Converts a HTML file to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations
requiring this type of objects
|
| ConvertHtmlFileToStream |
Converts a HTML file to PDF and writes the rendered PDF document into a stream
|
| ConvertHtmlStream(Stream, Encoding, String) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and returns the rendered PDF document into a memory buffer
|
| ConvertHtmlStream(Stream, Encoding, String, String) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and an internal links base URL
and returns the rendered PDF document into a memory buffer
|
| ConvertHtmlStreamToFile(Stream, Encoding, String, String) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and writes the rendered PDF document into a file
|
| ConvertHtmlStreamToFile(Stream, Encoding, String, String, String) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and an internal links base URL
and writes the rendered PDF document into a file
|
| ConvertHtmlStreamToPdfDocumentObject(Stream, Encoding, String) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and returns the rendered PDF document
as an object of the Document class that can be further used in other operations
requiring this type of objects.
|
| ConvertHtmlStreamToPdfDocumentObject(Stream, Encoding, String, String) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and an internal links and returns the rendered PDF document
as an object of the Document class that can be further used in other operations
requiring this type of objects.
|
| ConvertHtmlStreamToStream(Stream, Encoding, String, Stream) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and writes the rendered PDF document into a stream
|
| ConvertHtmlStreamToStream(Stream, Encoding, String, String, Stream) |
Converts a HTML string read from a stream to PDF using a base URL to resolve external resources and an internal links base URL and writes the rendered PDF document into a stream
|
| ConvertHtmlToFile(String, String, String) |
Converts a HTML string to PDF using a base URL to resolve external resources and writes the rendered PDF document into a file
|
| ConvertHtmlToFile(String, String, String, String) |
Converts a HTML string to PDF using a base URL to resolve external resources and an internal links base URL and writes the rendered PDF document into a file
|
| ConvertHtmlToPdfDocumentObject(String, String) |
Converts a HTML string to PDF using a base URL to resolve external resources and returns the rendered PDF document
as an object of the Document class that can be further used in other operations
requiring this type of objects.
|
| ConvertHtmlToPdfDocumentObject(String, String, String) |
Converts a HTML string to PDF using a base URL to resolve external resources and an internal links base URL and returns the rendered PDF document
as an object of the Document class that can be further used in other operations
requiring this type of objects.
|
| ConvertHtmlToStream(String, String, Stream) |
Converts a HTML string to PDF using a base URL to resolve external resources and writes the rendered PDF document into a stream
|
| ConvertHtmlToStream(String, String, String, Stream) |
Converts a HTML string to PDF using a base URL to resolve external resources and an internal links base URL and writes the rendered PDF document into a stream
|
| ConvertUrl |
Converts an URL to PDF and returns the rendered PDF document into a memory buffer
|
| ConvertUrlToFile |
Converts an URL to PDF and writes the rendered PDF document into a file
|
| ConvertUrlToPdfDocumentObject |
Converts an URL to PDF and returns the rendered PDF document as an object of the Document class that can be further used in other operations
requiring this type of objects
|
| ConvertUrlToStream |
Converts an URL to PDF and writes the rendered PDF document into a stream
|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetPageCount(Stream) |
A fast method to obtain the page count of a PDF document from the specified stream.
|
| GetPageCount(String) |
A fast method to obtain the page count of a PDF document from the specified file path.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | AfterRenderPdfPageEvent |
The event is raised right after the HTML to PDF converter finished PDF page rendering. The PDF page configuration like
size, orientation, header or footer is already defined and cannot be changed.
In the handler of this event PDF elements can be added in the foreground of the rendered PDF page.
|
| BeforeRenderPdfPageEvent |
The event is raised right before the page is rendered by HTML to PDF converter. The PDF page configuration like
size, orientation, header or footer is already defined and cannot be changed.
In the handler of this event PDF elements can be added in the background of the PDF page to be rendered.
|
| NavigationCompletedEvent |
The event is raised right after the converter finished the navigation and before rendering HTML content to PDF
|
| PrepareRenderPdfPageEvent |
The event is raised after the HTML to PDF converter created the PDF page and before starting rendering it.
In the handler of this event the PDF page configuration like size, orientation, header or footer can still be changed
before starting rendering.
|
See Also