Winnovative PDF Chromium for .NET Documentation
PdfDocumentOptions Class
This class encapsulates the options to control the PDF document redering process.
The HtmlToPdfConverter class defines a reference to an object of this type
Definition
Namespace: Winnovative.Pdf.Chromium
Assembly: Winnovative.Pdf.Chromium (in Winnovative.Pdf.Chromium.dll) Version: 19.0.0
Assembly: Winnovative.Pdf.Chromium (in Winnovative.Pdf.Chromium.dll) Version: 19.0.0
C#
public class PdfDocumentOptions- Inheritance
- Object PdfDocumentOptions
Properties
| AutoResizePdfPageWidth | Automatically resize the PDF page width to a custom value to match the HtmlViewerWidth at the default 96 DPI resolution while the PDF page height is still taken from PdfPageSize property. The default value is true |
| BottomMargin | The rendered PDF document bottom margin in points. 1 point is 1/72 inch. By default the left margin is 0. |
| EnableHeaderFooter | Indicates whether internal browser capabilities will be used to generate the header and footer based on the HeaderTemplate and FooterTemplate properties. This provides basic support for adding HTML with page numbering in the header and footer. For more advanced options, use the PdfHtmlHeader and PdfHtmlFooter properties instead. The default value is false. |
| FooterTemplate | The HTML template used for the PDF document footer. It should be valid HTML markup and may include the following CSS classes to inject dynamic values: date (formatted print date), title (document title), url (document location), pageNumber (current page number), and totalPages (total number of pages). For example, <span class="title"></span> will render a span containing the document title. This template is used only if the EnableHeaderFooter property is true. For advanced scenarios, use the PdfHtmlFooter property. If null or empty, a default template will be applied. |
| GenerateDocumentOutline | A flag indicating if an outline with bookmarks is automatically generated in the PDF document. The default is false. |
| GenerateTableOfContents | A flag indicating if a table of contents is automatically generated in the PDF document. The default is false |
| GenerateTaggedPdf | A flag indicating if the generated PDF document is tagged for accessibility. The default is false. |
| HeaderTemplate | The HTML template used for the PDF document header. It should be valid HTML markup and may include the following CSS classes to inject dynamic values: date (formatted print date), title (document title), url (document location), pageNumber (current page number), and totalPages (total number of pages). For example, <span class="title"></span> will render a span containing the document title. This template is used only if the EnableHeaderFooter property is true. For advanced scenarios, use the PdfHtmlHeader property. If null or empty, a default template will be applied. |
| LeftMargin | The rendered PDF document left margin in points. 1 point is 1/72 inch. By default the left margin is 0. |
| PageNumberLimit | The maximum number of PDF pages to generate from conversion. The default value is 0 and the entire HTML document will be converted to PDF |
| PdfHtmlFooter | The generated PDF document footer based on a HTML template given by Html and HtmlBaseUrl properties or by the HtmlSourceUrl property |
| PdfHtmlHeader | The generated PDF document header based on a HTML template given by Html and HtmlBaseUrl properties or by the HtmlSourceUrl property |
| PdfPageOrientation | This property controls the orientation of the pages of the PDF document generated by the HTML to PDF converter. The default orientation is Portrait |
| PdfPageSize | This property controls the page size of the PDF document generated by the HTML to PDF converter. The default size of the PDF document page is A4 |
| PreferCssPageSize | A flag indicating if to prefer page size as defined by css. The default value is false and the HTML content will be scaled to fit the page size specified by PdfPageSize property |
| PrintBackgrounds | A flag indicating if background graphics are printted by HTML to PDF converter. The default is true. |
| RepeatTableHeaderFooter | Enables automatic repetition of HTML table header (thead) and footer (tfoot) sections on each page when converting the HTML to PDF. It is useful for long tables that span multiple pages, ensuring headers and footers remain visible throughout. Styling rules intended for print layout will be applied when rendering the repeated sections. The default value is false. |
| RightMargin | The rendered PDF document right margin in points. 1 point is 1/72 inch. By default the right margin is 0. |
| TableOfContents | The table of contents options. To enable the creation of table of contents from heading tags set the GenerateTableOfContents property on true |
| TopMargin | The rendered PDF document top margin in points. 1 point is 1/72 inch. By default the top margin is 0. |
| UseBrowserOutlineMode | A flag indicating if the document outline is created in browser mode. The default is false |
Methods
| AddEndPdf(Byte[]) | Add a PDF to the list of documents to be included after the converted HTML content in the final PDF |
| AddEndPdf(String) | Add a PDF from a file to the list of documents to be included after the converted HTML content in the final PDF |
| AddHtmlTemplate(Int32, Int32, Int32, String) | Creates a HTML Template object based on the HTML string and an optional base URL. The height of template is auto-resized. To create a template with fixed height use the method with height parameter |
| AddHtmlTemplate(Int32, Int32, Int32, Int32, String) | Creates a HTML Template object based on URL from which the HTML content should be retrieved. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height |
| AddHtmlTemplate(Int32, Int32, Int32, String, String) | Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. The height of template is auto-resized. To create a template with fixed height use the method with height parameter |
| AddHtmlTemplate(Int32, Int32, Int32, Int32, String, String) | Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height |
| AddHtmlTemplate(Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String) | Creates a HTML Template object based on the HTML string and an optional base URL. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is auto-resized. To create a template with fixed height use the method with height parameter |
| AddHtmlTemplate(Int32, Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String) | Creates a HTML Template object based on URL from which the HTML content should be retrieved. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height |
| AddHtmlTemplate(Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String, String) | Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is auto-resized. To create a template with fixed height use the method with height parameter |
| AddHtmlTemplate(Int32, Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String, String) | Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height. |
| AddStartPdf(Byte[]) | Add a PDF from a memory buffer to the list of documents to be included before the converted HTML content in the final PDF |
| AddStartPdf(String) | Add a PDF from a file to the list of documents to be included before the converted HTML content in the final PDF |
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |