Winnovative PDF Next Library for .NET Documentation
Pdf
This class encapsulates the options to control the PDF document rendering process.
The HtmlToPdfConverter class defines a reference to an object of this type
Definition
Namespace: Winnovative.Pdf.Next
Assembly: Winnovative.Pdf.Next (in Winnovative.Pdf.Next.dll) Version: 21.0.3
Assembly: Winnovative.Pdf.Next (in Winnovative.Pdf.Next.dll) Version: 21.0.3
C#
public class PdfDocumentOptions- Inheritance
- Object PdfDocumentOptions
Properties
| AutoResizePdfPageHeight | When true, the PDF page is as tall as the HTML content, so the whole content is on one page; the page width comes from the page size or, when AutoResizePdfPageWidth is true, from the browser window. The browser window height is not used: the page is as tall as the content. The default value is false |
| AutoResizePdfPageWidth | When true, the PDF page width follows the browser window width, HtmlViewerWidth times 0.75 points, and the HTML is drawn at HtmlViewerZoom, 100 percent unless set. The window width and the zoom are then not computed by the layout methods: the values set are used, 1024 pixels and 100 percent by default. Setting the property back to false restores the layout of the last layout method called. When false, the page has the size given by PdfPageSize and the HTML is laid out for that page. PageWidthFromBrowserWindow sets this property to true; the other layout methods set it to false. To make the page follow the browser window, prefer calling PageWidthFromBrowserWindow, which also sets the window width and the zoom. The default value is false |
| Bookmarks | The bookmarks added to the outline of the generated document, after the bookmarks created from the headings of the HTML document. The page numbers refer to the pages of the generated document, including the pages of the table of contents and of the PDF documents added before the HTML content, and the location in a page is given from the top left corner of the page |
| 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 |
| FirstPageTopMargin | The top margin of the first page in points, when the content of the first page starts lower than on the other pages, for a letterhead or a cover. A negative value, the default, gives the first page the same top margin as the other pages. A header shown on the first page keeps its space |
| 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 the generated PDF document will have an outline with bookmarks created from HTML heading tags (H1 to H6) or from any element marked with the data-heading attribute. Any element can become a bookmark with data-heading set to a level from 1 to 6 (for example data-heading="2"), the bookmark title is taken from the data-heading-text attribute when present otherwise from the element text. A real heading can be excluded with data-heading="false". The custom data-heading attribute is honored only in custom mode when UseBrowserOutlineMode is false. The default is false |
| GeneratePdfFormFields | Gets or sets a value indicating whether HTML form controls are converted into interactive PDF form fields |
| GenerateTableOfContents | A flag indicating if a table of contents is automatically generated in the PDF document from HTML heading tags (H1 to H6) or from any element marked with the data-heading attribute. The table of contents appearance and behavior are controlled by the options exposed through the TableOfContents property. 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 |
| OpenAction | The action executed by the viewer when the generated document is opened: go to a page at a given location and zoom, go to a named destination, run JavaScript, a viewer action or open a web address. When null, the document has no open action. The default is null |
| OutlineHeadingSelectors | The CSS selectors of the elements that become bookmarks of the document outline, one selector for each level: the first selector gives the level 1 bookmarks, the second one the level 2 bookmarks and so on, up to level 6. When this property is set the H1 to H6 headings and the data-heading attribute no longer select the bookmarks, an element still being excluded with data-heading="false" and its title still being taken from data-heading-text when present. The selectors are honored in custom mode when UseBrowserOutlineMode is false. The default is null, the bookmarks being created from the headings of the document |
| 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 |
| PdfFormOptions | Gets the options used to convert HTML form controls into interactive PDF form fields |
| 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. When AutoResizePdfPageWidth is true (the default value is false), the converter automatically resizes the PDF page width to match the HtmlViewerWidth value at the default 96 DPI resolution. When AutoResizePdfPageHeight is true (the default value is false), the converter automatically resizes the PDF page height to match the HTML content height at the default 96 DPI resolution. The page has this exact size when both properties are false. The default size of the PDF document page is A4 |
| PdfStandard | Gets or sets the PDF standards compliance level for the generated document. The default is None which means plain PDF without tagging |
| PreferCssPageSize | When true, a @page size rule in the HTML sets the PDF page size instead of PdfPageSize. The default value is false |
| 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 controlling the title, style, page numbers, inline placement and creation mode. To enable the creation of the table of contents from HTML heading tags or data-heading elements, set the GenerateTableOfContents property to 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 custom data-heading, data-heading-text and data-heading="false" attributes and the OutlineHeadingSelectors are honored only in custom mode. In browser mode only the standard H1 to H6 heading tags are used. The default is false |
Methods
| AddElectronicInvoice | Embeds a Factur-X / ZUGFeRD electronic invoice in the generated PDF document: the invoice XML is attached under the file name the standard prescribes, with the relationship of its profile, and the Factur-X identification metadata is written in the XMP metadata. The document must be generated as PDF/A-3 (PdfA3b, PdfA3u, PdfA3a or PdfUa1PdfA3a for an accessible invoice). A document carries one electronic invoice |
| 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 |
| AddFileAttachment | Adds a file to the document's attachments. The attachment appears in the Attachments panel of PDF viewers |
| 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 template has the given height. When AutoSizeContentHeight is true, the HTML content may be scaled down to fit the given 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 template has the given height. When AutoSizeContentHeight is true, the HTML content may be scaled down to fit the given 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 template has the given height. When AutoSizeContentHeight is true, the HTML content may be scaled down to fit the given 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 template has the given height. When AutoSizeContentHeight is true, the HTML content may be scaled down to fit the given 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) |