RtfSaveOptions class
RtfSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.RTF format. To learn more, visit the Specify Save Options documentation article.
Inheritance: RtfSaveOptions → SaveOptions
Constructors
| Name | Description |
|---|---|
| RtfSaveOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| allow_embedding_post_script_fonts | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is False.(Inherited from SaveOptions) |
| default_template | Gets or sets path to default template (including filename). Default value for this property is empty string (). (Inherited from SaveOptions) |
| dml_3d_effects_rendering_mode | Gets or sets a value determining how 3D effects are rendered. (Inherited from SaveOptions) |
| dml_effects_rendering_mode | Gets or sets a value determining how DrawingML effects are rendered. (Inherited from SaveOptions) |
| dml_rendering_mode | Gets or sets a value determining how DrawingML shapes are rendered. (Inherited from SaveOptions) |
| export_compact_size | Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly. |
| export_generator_name | When True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.(Inherited from SaveOptions) |
| export_images_for_old_readers | Specifies whether the keywords for “old readers” are written to RTF or not. This can significantly affect the size of the RTF document. |
| iml_rendering_mode | Gets or sets a value determining how ink (InkML) objects are rendered. (Inherited from SaveOptions) |
| memory_optimization | Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is False.(Inherited from SaveOptions) |
| pretty_format | When True, pretty formats output where applicable. Default value is False.(Inherited from SaveOptions) |
| progress_callback | Called during saving a document and accepts data about saving progress. (Inherited from SaveOptions) |
| save_format | Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.RTF. |
| save_images_as_wmf | When True all images will be saved as WMF. |
| temp_folder | Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is None and no temporary files are used.(Inherited from SaveOptions) |
| update_created_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;(Inherited from SaveOptions) |
| update_fields | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is True.(Inherited from SaveOptions) |
| update_last_printed_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving. (Inherited from SaveOptions) |
| update_last_saved_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving. (Inherited from SaveOptions) |
| use_anti_aliasing | Gets or sets a value determining whether or not to use anti-aliasing for rendering. (Inherited from SaveOptions) |
| use_high_quality_rendering | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. (Inherited from SaveOptions) |
Methods
| Name | Description |
|---|---|
| create_save_options(save_format) | Creates a save options object of a class suitable for the specified save format. (Inherited from SaveOptions) |
| create_save_options(file_name) | Creates a save options object of a class suitable for the file extension specified in the given file name. (Inherited from SaveOptions) |
Examples
Shows how to save a document to .rtf with custom options.
doc = aw.Document(MY_DIR + 'Rendering.docx')
# Create an "RtfSaveOptions" object to pass to the document's "save" method to modify how we save it to an RTF.
options = aw.saving.RtfSaveOptions()
self.assertEqual(aw.SaveFormat.RTF, options.save_format)
# Set the "export_compact_size" property to "True" to
# reduce the saved document's size at the cost of right-to-left text compatibility.
options.export_compact_size = True
# Set the "export_images_for_old_readers" property to "True" to use extra keywords to ensure that our document is
# compatible with pre-Microsoft Word 97 readers and WordPad.
# Set the "export_images_for_old_readers" property to "False" to reduce the size of the document,
# but prevent old readers from being able to read any non-metafile or BMP images that the document may contain.
options.export_images_for_old_readers = export_images_for_old_readers
doc.save(ARTIFACTS_DIR + 'RtfSaveOptions.export_images.rtf', options)
See Also
- module aspose.words.saving
- class SaveOptions