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: EvoPdf.Chromium
Assembly: EvoPdf.Chromium (in EvoPdf.Chromium.dll) Version: 11.4.0
C#
public class PdfDocumentOptions
Inheritance
Object    PdfDocumentOptions

Constructors

PdfDocumentOptionsInitializes a new instance of the PdfDocumentOptions class

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 A flag indicating if the header and footer defined by the HeaderTemplateHtml and FooterTemplateHtml will be generated in the PDF document. The default is false
FooterTemplate The PDF document footer template which should be valid HTML markup with following classes used to inject values: date: formatted print date, title: document title, url: document location, pageNumber: current page number, totalPages: total pages in the document. For example, would generate span containing the title. If it is null or empty a default template will be used
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 PDF document header template which should be valid HTML markup with following classes used to inject values: date: formatted print date, title: document title, url: document location, pageNumber: current page number, totalPages: total pages in the document. For example, would generate span containing the title. If it is null or empty a default template will be used
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
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.
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
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)

See Also