WordProcessingLoadOptions class Leave feedback
On this page
Provides 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:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of WordProcessingLoadOptions. |
| Method | Description |
|---|---|
| equals | Determines whether two object instances are equal. (inherited from ValueObject) |
| equals_object | (inherited from ValueObject) |
| equals_value_object | (inherited from ValueObject) |
| get_hash_code | Serves as the default hash function. (inherited from ValueObject) |
| Property | Description |
|---|---|
| auto_detect_rtl_direction | The auto_detect_rtl_direction property determines whether paragraphs and runs with predominantly right-to-left text have their bidi flags repaired before conversion. |
| bookmark_options | The bookmarks options. |
| clear_built_in_document_properties | The flag indicating whether built‑in document properties are cleared when loading a Word processing document. |
| clear_custom_document_properties | The ClearCustomDocumentProperties property. |
| comment_display_mode | The comment display mode specifies how comments should be displayed in the output document. Default is ShowInBalloons. |
| convert_owned | The property implements IDocumentsContainerLoadOptions.convert_owned. Default is False. |
| convert_owner | The convert_owner flag indicates whether to convert the document owner. Default is True. |
| default_font | The default font for a WordProcessing document. |
| depth | The depth of the document container load options. Default is 1. |
| embed_true_type_fonts | The embed_true_type_fonts property determines whether true type fonts are embedded in the output document. Default is True. |
| font_config_substitution_enabled | The property enables automatic substitution of missing fonts based on the system FontConfig. Default is False. |
| font_info_substitution_enabled | The flag that enables automatic substitution of missing fonts based on FontInfo in the document. Default: False. |
| font_name_substitution_enabled | The property indicates whether missing fonts are automatically substituted 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, allowing modification of any fonts in the document, including those successfully loaded. |
| format | The input document file type. |
| hide_word_tracked_changes | The hide_word_tracked_changes 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 determines whether the original value of a date field is kept. Default is False. |
| margin_settings | The margin settings. |
| page_numbering | The page numbering generation flag for the converted document (default: False). |
| password | The password to unprotect a protected document. |
| preserve_document_structure | The flag indicating whether the document structure should be preserved when converting to PDF (default is False). |
| preserve_form_fields | The property indicates whether Microsoft Word form fields are preserved as form fields in the resulting PDF or converted to text. The default is False. |
| show_full_commenter_name | The full commenter name is shown in comments when set to True. Default is False. |
| size_settings | The size settings for the WordProcessing document (IPageSizeOptions). |
| skip_external_resources | The flag that determines whether external resources are skipped when loading a document. |
| update_fields | The option to update fields after loading. Default: False. |
| update_page_layout | The page layout is updated after loading. Default: False. |
| use_text_shaper | The property indicates whether to use a text shaper for better kerning display. Default is False. |
| whitelisted_resources | The whitelisted resources for loading external content, implementing IResourceLoadingOptions.whitelisted_resources. |
from groupdocs.conversion.options.load import WordProcessingLoadOptions
load_options = WordProcessingLoadOptions()
load_options.password = "secret"
Task guides that use WordProcessingLoadOptions:
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
