Html to PDF converter component (C# WkHtmlToPdf process wrapper).
Inheritance Hierarchy
NReco.PdfGeneratorHtmlToPdfConverter
Namespace: NReco.PdfGenerator
Assembly: NReco.PdfGenerator (in NReco.PdfGenerator.dll) Version: 1.2.1
Syntax
The HtmlToPdfConverter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | HtmlToPdfConverter |
Create new instance of HtmlToPdfConverter
|
Properties
| Name | Description | |
|---|---|---|
 | CustomWkHtmlArgs |
Custom WkHtmlToPdf global options
|
| CustomWkHtmlCoverArgs |
Custom WkHtmlToPdf cover options (applied only if cover content is specified)
|
| CustomWkHtmlPageArgs |
Custom WkHtmlToPdf page options
|
| CustomWkHtmlTocArgs |
Custom WkHtmlToPdf toc options (applied only if GenerateToc is true)
|
| ExecutionTimeout |
Get or set maximum execution time for PDF generation process (by default is null that means no timeout)
|
| GenerateToc |
Gets or sets TOC generation flag
|
| Grayscale |
Gets or sets option to generate grayscale PDF
|
| License |
Component commercial license information.
|
| LowQuality |
Gets or sets option to generate low quality PDF (shrink the result document space)
|
| Margins |
Gets or sets PDF page margins (in mm)
|
| Orientation |
Get or set PDF page orientation
|
| PageFooterHtml |
Get or set custom page footer HTML
|
| PageHeaderHtml |
Get or set custom page header HTML
|
| PageHeight |
Gets or sets PDF page height (in mm)
|
| PageWidth |
Gets or sets PDF page width (in mm)
|
| PdfToolPath |
Get or set path where WkHtmlToPdf tool is located
|
| ProcessPriority |
Gets or sets wkhtmltopdf process priority (Normal by default)
|
| ProcessProcessorAffinity |
Gets or sets wkhtmltopdf processor affinity (bitmask that represents the processors that may be used by the process threads).
|
| Quiet |
Suppress wkhtmltopdf debug/info log messages (by default is true)
|
| Size |
Get or set PDF page orientation
|
| TempFilesPath |
Get or set location for temp files (if not specified location returned by GetTempPath is used for temp files)
|
| TocHeaderText |
Gets or sets custom TOC header text (default: "Table of Contents")
|
| WkHtmlToPdfExeName |
Get or set WkHtmlToPdf tool EXE file name ('wkhtmltopdf.exe' by default)
|
| Zoom |
Gets or sets zoom factor
|
Methods
| Name | Description | |
|---|---|---|
| BeginBatch |
Intiates PDF processing in the batch mode (generate several PDF documents using one wkhtmltopdf process)
|
| EndBatch |
Ends PDF processing in the batch mode.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GeneratePdf(String) |
Generates PDF by specifed HTML content
|
| GeneratePdf(String, String) |
Generates PDF by specfied HTML content and prepend cover page (useful with GenerateToc option)
|
| GeneratePdf(String, String, Stream) |
Generates PDF by specfied HTML content (optionally with the cover page).
|
| GeneratePdf(String, String, String) |
Generates PDF by specfied HTML content (optionally with the cover page).
|
| GeneratePdfFromFile(String, String) |
Generate PDF by specfied HTML content and prepend cover page (useful with GenerateToc option)
|
| GeneratePdfFromFile(String, String, Stream) |
Generate PDF by specfied HTML content and prepend cover page (useful with GenerateToc option)
|
| GeneratePdfFromFile(String, String, String) |
Generate PDF by specfied HTML content and prepend cover page (useful with GenerateToc option)
|
| GeneratePdfFromFiles(String, String, Stream) |
Generate PDF into specified Stream by several HTML documents (local files or URLs)
|
| GeneratePdfFromFiles(String, String, String) |
Generate PDF into specified output file by several HTML documents (local files or URLs)
|
| GeneratePdfFromFiles(WkHtmlInput, String, String) |
Generate PDF into specified output file by several HTML documents (local files or URLs)
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | LogReceived |
Occurs when log line is received from WkHtmlToPdf process
|
See Also