DocSaveOptions class
DocSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.DOC or SaveFormat.DOT format. To learn more, visit the Specify Save Options documentation article.
Remarks
At the moment provides only the DocSaveOptions.save_format property, but in the future will have other options added, such as an encryption password or digital signature settings.
Inheritance: DocSaveOptions → SaveOptions
Constructors
| Name | Description |
|---|---|
| DocSaveOptions() | Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC format. |
| DocSaveOptions(save_format) | Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC or SaveFormat.DOT format. |
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) |
| always_compress_metafiles | When False, small metafiles are not compressed for performance reason. Default value is True, all metafiles are compressed regardless of its size. |
| default_template | Gets or sets path to default template (including filename). Default value for this property is empty string (). (Inherited from SaveOptions) |
| digital_signature_details | Gets or sets DigitalSignatureDetails object used to sign a document. |
| 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_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) |
| 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) |
| password | Gets/sets a password to encrypt document using RC4 encryption method. |
| 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 be SaveFormat.DOC or SaveFormat.DOT. |
| save_picture_bullet | When False, PictureBullet data is not saved to output document. Default value is True. |
| save_routing_slip | When False, RoutingSlip data is not saved to output document. Default value is True. |
| 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 set save options for older Microsoft Word formats.
doc = aw.Document()
builder = aw.DocumentBuilder(doc)
builder.write('Hello world!')
options = aw.saving.DocSaveOptions(aw.SaveFormat.DOC)
# Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
# Note that this does not encrypt the contents of the document in any way.
options.password = 'MyPassword'
# If the document contains a routing slip, we can preserve it while saving by setting this flag to True.
options.save_routing_slip = True
doc.save(ARTIFACTS_DIR + 'DocSaveOptions.save_as_doc.doc', options)
# To be able to load the document,
# we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
with self.assertRaises(Exception):
doc = aw.Document(ARTIFACTS_DIR + 'DocSaveOptions.save_as_doc.doc')
load_options = aw.loading.LoadOptions('MyPassword')
doc = aw.Document(ARTIFACTS_DIR + 'DocSaveOptions.save_as_doc.doc', load_options)
self.assertEqual('Hello world!', doc.get_text().strip())
See Also
- module aspose.words.saving
- class SaveOptions