 | |
Word | |
Controls the Word to PDF conversion process and the properties of the generated PDF document.
Inheritance HierarchySystemObject
SelectPdf.UniversalWordToPdfOptions
SelectPdf.UniversalWordToPdfOptions
Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4
SyntaxThe WordToPdfOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WordToPdfOptions |
Properties| Name | Description | |
|---|---|---|
 | AccessibilityStandard | Gets or sets the universal accessibility standard the produced document declares. The default is None. |
| AutoDetectComplexScript | Gets or sets whether text in complex scripts (Arabic, Hebrew, Thai and the like) that the document did not mark as such is detected and shaped accordingly. Default: false. |
| Bookmarks | Gets or sets what the pdf outline is built from: the document's headings (the default), its Word bookmarks, or nothing. |
| ColorSpace | Gets or sets the color space of the generated pdf. Default: RGB. |
| DisplayFooter | Gets or sets whether the custom footer set on Footer is displayed. Default: false. |
| DisplayHeader | Gets or sets whether the custom header set on Header is displayed. Default: false. |
| EmbedCompleteFonts | Gets or sets whether the fonts are embedded whole rather than as the subset of glyphs the document uses. A whole font makes the pdf larger and editable afterwards. Default: false. |
| ExternalLinksEnabled | Gets or sets whether the hyperlinks of the Word document that point to a web address are kept as clickable links in the generated pdf. Default: true. |
| GenerateSinglePagePdf | Gets or sets whether the whole document is rendered onto one tall pdf page. Default: false. |
| InternalLinksEnabled | Gets or sets whether the hyperlinks of the Word document that point inside the document (to a bookmark or a heading) are kept as clickable links in the generated pdf. Default: true. |
| JpegCompressionEnabled | Gets or sets whether the images of the generated pdf are re-encoded as JPEG at the quality given by JpegCompressionLevel. Default: true. |
| JpegCompressionLevel | Gets or sets the JPEG compression level, from 0 (best quality) to 100 (smallest file). Default: 10. |
| Language | Gets or sets the natural language of the text in a tagged PDF (see Tagged), as a BCP 47 language tag such as en-US. When not set, defaults to en-US. |
| LFN | Gets or sets the path of a log file the converter writes diagnostic messages to. Default: null (no log). |
| MarginBottom | Gets or sets the bottom margin of the generated pdf pages, in points. Default: 0. |
| MarginLeft | Gets or sets the left margin of the generated pdf pages, in points, applied around the rendered Word page. Default: 0. |
| MarginRight | Gets or sets the right margin of the generated pdf pages, in points. Default: 0. |
| MarginTop | Gets or sets the top margin of the generated pdf pages, in points. Default: 0. |
| OptimizeIdenticalImages | Gets or sets whether an image used several times in the document is stored once in the pdf. Default: true. |
| PageRanges | Gets or sets the pages of the rendered document that go into the pdf, e.g. "1", "2-4", "1-3,5,7-" (1-based). Empty, the default, keeps every page. |
| PageSetup | Gets or sets where the pages take their size, orientation and margins from: the Word document's own page setup (the default) or the PdfPageSize, PdfPageOrientation and margins set on these options. |
| Password | Gets or sets the password of an encrypted Word document. Default: null. |
| PdfCompressionLevel | Gets or sets the compression level of the content streams and fonts of the generated pdf. Default: Normal. |
| PdfDocumentInformation | Gets a reference to the object that sets the document information (title, author, subject, keywords, producer, creation date) of the generated pdf. |
| PdfPageCustomSize | Gets or sets the custom page size, in points, used when PdfPageSize is Custom. |
| PdfPageOrientation | Gets or sets the orientation of the generated pdf pages when PageSetup is Options. Default: Portrait. |
| PdfPageSize | Gets or sets the size of the generated pdf pages. Used when PageSetup is Options; with Document every page has the size of the Word page it was rendered from. Default: A4. |
| PdfStandard | Gets or sets the PDF standard (PDF/A, PDF/X) the generated pdf conforms to. Default: Full (no standard). |
| PreserveFormFields | Gets or sets whether the document's form fields become fillable pdf form fields instead of flat text. Default: false. |
| SecurityOptions | Gets a reference to the object that sets the security options (passwords, permissions, encryption) of the generated pdf. |
| Tagged | Gets or sets a value indicating whether the produced document is a tagged (accessible) PDF carrying a logical-structure tree, suitable for PDF/UA. The default is false. |
| Title | Gets or sets the document title recorded in the metadata of a tagged PDF (see Tagged). Accessible documents are required to declare a title. When not set, the title of PdfDocumentInformation is used. |
| UpdateFields | Gets or sets whether the document's fields - the table of contents, page counts, dates and the like - are recalculated before rendering, so the pdf does not carry stale values. Default: true. |
| ViewerPreferences | Gets a reference to the object that sets the viewer preferences of the generated pdf. |
Remarks
The options shared with the html converter (page size and margins, header and footer display,
links, compression, document information, security, viewer preferences, standards) have the
same names, types and defaults as on HtmlToPdfOptions. The Word-specific options
are PageSetup, Password, Bookmarks,
UpdateFields, PreserveFormFields, EmbedCompleteFonts,
AutoDetectComplexScript and OptimizeIdenticalImages.
See Also