OdtSaveOptions class

OdtSaveOptions class

Can be used to specify additional options when saving a document into the SaveFormat.ODT or SaveFormat.OTT format. To learn more, visit the Specify Save Options documentation article.

Remarks

At the moment provides only the OdtSaveOptions.save_format property, but in the future will have other options added, such as an encryption password or digital signature settings.

Inheritance: OdtSaveOptionsSaveOptions

Constructors

NameDescription
OdtSaveOptions()Initializes a new instance of this class that can be used to save a document in the SaveFormat.ODT format.
OdtSaveOptions(password)Initializes a new instance of this class that can be used to save a document in the SaveFormat.ODT format encrypted with a password.
OdtSaveOptions(save_format)Initializes a new instance of this class that can be used to save a document in the SaveFormat.ODT or SaveFormat.OTT format.

Properties

NameDescription
allow_embedding_post_script_fontsGets 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_templateGets or sets path to default template (including filename). Default value for this property is empty string ().
(Inherited from SaveOptions)
dml_3d_effects_rendering_modeGets or sets a value determining how 3D effects are rendered.
(Inherited from SaveOptions)
dml_effects_rendering_modeGets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions)
dml_rendering_modeGets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions)
export_generator_nameWhen True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.
(Inherited from SaveOptions)
iml_rendering_modeGets or sets a value determining how ink (InkML) objects are rendered.
(Inherited from SaveOptions)
is_strict_schema11Specifies whether export should correspond to ODT specification 1.1 strictly. OOo 3.0 displays files correctly when they contain elements and attributes of ODT 1.2. Use “false” for this purpose, or “true” for strict conformity of specification 1.1. The default value is False.
measure_unitAllows to specify units of measure to apply to document content. The default value is OdtSaveMeasureUnit.CENTIMETERS
memory_optimizationGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is False.
(Inherited from SaveOptions)
passwordGets or sets a password to encrypt document.
pretty_formatWhen True, pretty formats output where applicable. Default value is False.
(Inherited from SaveOptions)
progress_callbackCalled during saving a document and accepts data about saving progress.
(Inherited from SaveOptions)
save_formatSpecifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.ODT or SaveFormat.OTT.
temp_folderSpecifies 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_propertyGets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;
(Inherited from SaveOptions)
update_fieldsGets 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_propertyGets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving.
(Inherited from SaveOptions)
update_last_saved_time_propertyGets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving.
(Inherited from SaveOptions)
use_anti_aliasingGets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions)
use_high_quality_renderingGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions)

Methods

NameDescription
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 make a saved document conform to an older ODT schema.

doc = aw.Document(MY_DIR + "Rendering.docx")

save_options = aw.saving.OdtSaveOptions()
save_options.measure_unit = aw.saving.OdtSaveMeasureUnit.CENTIMETERS
save_options.is_strict_schema11 = export_to_odt11_specs

doc.save(ARTIFACTS_DIR + "OdtSaveOptions.odt11_schema.odt", save_options)

Shows how to use different measurement units to define style parameters of a saved ODT document.

doc = aw.Document(MY_DIR + "Rendering.docx")

# When we export the document to .odt, we can use an OdtSaveOptions object to modify how we save the document.
# We can set the "measure_unit" property to "OdtSaveMeasureUnit.CENTIMETERS"
# to define content such as style parameters using the metric system, which Open Office uses.
# We can set the "measure_unit" property to "OdtSaveMeasureUnit.INCHES"
# to define content such as style parameters using the imperial system, which Microsoft Word uses.
save_options = aw.saving.OdtSaveOptions()
save_options.measure_unit = odt_save_measure_unit

doc.save(ARTIFACTS_DIR + "OdtSaveOptions.measurement_units.odt", save_options)

See Also