RtfLoadOptions class
RtfLoadOptions class
Allows to specify additional options when loading LoadFormat.RTF document into a Document object. To learn more, visit the Specify Load Options documentation article.
Inheritance: RtfLoadOptions → LoadOptions
Constructors
| Name | Description |
|---|---|
| RtfLoadOptions() | Initializes a new instance of this class with default values. |
Properties
| Name | Description |
|---|---|
| base_uri | Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be None or empty string. Default is None.(Inherited from LoadOptions) |
| convert_metafiles_to_png | Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format. (Inherited from LoadOptions) |
| convert_shape_to_office_math | Gets or sets whether to convert shapes with EquationXML to Office Math objects. (Inherited from LoadOptions) |
| encoding | Gets or sets the encoding that will be used to load an HTML, TXT, or CHM document if the encoding is not specified inside the document. Can be None. Default is None.(Inherited from LoadOptions) |
| font_settings | Allows to specify document font settings. (Inherited from LoadOptions) |
| ignore_ole_data | Specifies whether to ignore the OLE data. (Inherited from LoadOptions) |
| language_preferences | Gets language preferences that will be used when document is loading. (Inherited from LoadOptions) |
| load_format | Specifies the format of the document to be loaded. Default is LoadFormat.AUTO. (Inherited from LoadOptions) |
| msw_version | Allows to specify that the document loading process should match a specific MS Word version. Default value is MsWordVersion.WORD2019 (Inherited from LoadOptions) |
| password | Gets or sets the password for opening an encrypted document. Can be None or empty string. Default is None.(Inherited from LoadOptions) |
| preserve_include_picture_field | Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is False.(Inherited from LoadOptions) |
| progress_callback | Called during loading a document and accepts data about loading progress. (Inherited from LoadOptions) |
| recognize_utf8_text | When set to True, will try to detect UTF8 characters, they will be preserved during import. |
| resource_loading_callback | Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML. (Inherited from LoadOptions) |
| temp_folder | Allows to use temporary files when reading document. By default this property is None and no temporary files are used.(Inherited from LoadOptions) |
| update_dirty_fields | Specifies whether to update the fields with the dirty attribute.(Inherited from LoadOptions) |
| use_system_lcid | Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins. (Inherited from LoadOptions) |
| warning_callback | Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss. (Inherited from LoadOptions) |
Examples
Shows how to detect UTF-8 characters while loading an RTF document.
# Create an "RtfLoadOptions" object to modify how we load an RTF document.
load_options = aw.loading.RtfLoadOptions()
# Set the "recognize_utf8_text" property to "False" to assume that the document uses the ISO 8859-1 charset
# and loads every character in the document.
# Set the "recognize_utf8_text" property to "True" to parse any variable-length characters that may occur in the text.
load_options.recognize_utf8_text = recognize_utf8_text
doc = aw.Document(MY_DIR + 'UTF-8 characters.rtf', load_options)
if recognize_utf8_text:
self.assertEqual('“John Doe´s list of currency symbols”™\r' + '€, ¢, £, ¥, ¤', doc.first_section.body.get_text().strip())
else:
self.assertEqual('“John Doe´s list of currency symbolsâ€\x9dâ„¢\r' + '€, ¢, £, Â¥, ¤', doc.first_section.body.get_text().strip())
See Also
- module aspose.words.loading
- class LoadOptions