WordProcessingLoadOptions class
WordProcessingLoadOptions class
Options for loading WordProcessing documents.
Font Processing Pipeline:
Phase 1 - Font Substitution (during document loading):
- Handles missing/unavailable fonts using FontSubstitutes, DefaultFont, and system substitution
- Processing order: FontName → FontConfig → FontSubstitutes → FontInfo → DefaultFont
Phase 2 - Font Replacement (after document loading):
- Modifies any existing fonts in the loaded document using FontReplacements
- Applied after all font substitution is complete
The WordProcessingLoadOptions type exposes the following members:
Constructors
| Constructor | Description |
|---|---|
| init | Initializes a new instance of WordProcessingLoadOptions. |
Properties
| Property | Description |
|---|---|
| bookmark_options | The bookmarks options. |
| clear_built_in_document_properties | The clear_built_in_document_properties property. |
| clear_custom_document_properties | The ClearCustomDocumentProperties property indicates whether custom document properties should be cleared during loading. |
| comment_display_mode | The comment display mode specifies how comments should be displayed in the output document; the default is ShowInBalloons. |
| convert_owned | The ConvertOwned property implements IDocumentsContainerLoadOptions.convert_owned and defaults to false. |
| convert_owner | The property that implements IDocumentsContainerLoadOptions.convert_owner. Default is True. |
| default_font | The default font for a WordProcessing document. |
| depth | The depth of the document container load options. |
| embed_true_type_fonts | The embed_true_type_fonts property indicates whether true type fonts are embedded in the output document. The default value is True. |
| font_config_substitution_enabled | The property enables automatic substitution of missing fonts based on FontConfig in the system. Default: False. |
| font_info_substitution_enabled | The property enables automatic substitution of missing fonts based on FontInfo in the document. Default is False. |
| font_name_substitution_enabled | The property that enables automatic substitution of missing fonts based on the font name. Default: False. |
| font_substitutes | The font substitutes used when converting a WordProcessing document. |
| font_transformations | The font transformations applied after document loading and font substitution are complete. |
| format | The input document file type. |
| hide_word_tracked_changes | The property hides markup and track changes for Word documents. |
| hyphenation_options | The hyphenation options for WordProcessing documents. |
| keep_date_field_original_value | The keep_date_field_original_value property indicates whether to keep the original value of a date field. Default: False. |
| margin_settings | The margin settings for the Word processing document, represented by IPageMarginOptions. |
| page_numbering | The page numbering generation is enabled or disabled in the converted document (default: False). |
| password | The password used to unprotect a protected document. |
| preserve_document_structure | The property determines whether the document structure should be preserved when converting to PDF (default is False). |
| preserve_form_fields | The property determines whether Microsoft Word form fields are preserved as form fields in the PDF or converted to text. The default is False. |
| show_full_commenter_name | The full commenter name is shown in comments (default: False). |
| size_settings | The size settings. |
| skip_external_resources | The property that implements IResourceLoadingOptions.skip_external_resources. |
| update_fields | The setting updates fields after loading. Default: False. |
| update_page_layout | The page layout is updated after loading. Default: False. |
| use_text_shaper | The property specifies whether to use a text shaper for better kerning display; default is False. |
| whitelisted_resources | The property implements IResourceLoadingOptions.whitelisted_resources. |