HiQPdf Chromium for .NET Documentation
Word
This class encapsulates the options to control the PDF document redering process.
The WordToPdfConverter class defines a reference to an object of this type
Definition
Namespace: HiQPdf.Chromium
Assembly: HiQPdf.Chromium (in HiQPdf.Chromium.dll) Version: 17.5.0
Assembly: HiQPdf.Chromium (in HiQPdf.Chromium.dll) Version: 17.5.0
C#
public class WordToPdfDocumentOptions- Inheritance
- Object WordToPdfDocumentOptions
Properties
| AutoResizePdfPageHeight | Automatically resizes the PDF page height to match the Word content height. The default value is false |
| DigitalSignature | The digital signature to apply to generated PDF document |
| DisplayHeaderFooter | Indicates whether internal 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), 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. |
| 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), 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. |
| Margins | The PDF document margins. This property is used only when UsePageSettingsFromWord is set to false. By default all the margins are 0 |
| MaxPageCount | The maximum number of PDF pages to generate from conversion. The default value is 0 and the entire Word document will be converted to PDF |
| PageOrientation | This property controls the orientation of the pages of the PDF document generated by the Word to PDF converter. This property is used only when UsePageSettingsFromWord is set to false. The default orientation is Portrait |
| PageSize | This property controls the page size of the PDF document generated by the Word to PDF converter. This property is used only when UsePageSettingsFromWord is set to false. The default page size is A4. |
| 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 |
| Properties | Gets a reference to the object to controlling the generated PDF document information like the document title, author, subject or creation date |
| Security | The object exposed by this property can be used to password protect the PDF document, disable printing, copying or editing of the PDF document |
| UsePageSettingsFromWord | Whether to use page settings (size, margins) from the Word document (default: true) |
| Viewer | Controls the PDF viewer preferences |
| Zoom | Gets or sets the Word viewer zoom percentage as a positive number between 0 and 200. The default value of this property is 100 |
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, 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, 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, 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) | 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, 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 Word 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) |