WordML2003SaveOptions class

WordML2003SaveOptions class

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

Remarks

At the moment provides only the WordML2003SaveOptions.save_format property, but in the future may have other options added.

Inheritance: WordML2003SaveOptions → SaveOptions

Constructors

NameDescription
WordML2003SaveOptions()The default constructor.

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)
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)
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 only be SaveFormat.WORD_ML.
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 manage output document’s raw content.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
# Create a "WordML2003SaveOptions" object to pass to the document's "Save" method
# to modify how we save the document to the WordML save format.
options = aw.saving.WordML2003SaveOptions()
self.assertEqual(aw.SaveFormat.WORD_ML, options.save_format)
# Set the "PrettyFormat" property to "true" to apply tab character indentation and
# newlines to make the output document's raw content easier to read.
# Set the "PrettyFormat" property to "false" to save the document's raw content in one continuous body of the text.
options.pretty_format = pretty_format
doc.save(file_name=ARTIFACTS_DIR + 'WordML2003SaveOptions.PrettyFormat.xml', save_options=options)
file_contents = system_helper.io.File.read_all_text(ARTIFACTS_DIR + 'WordML2003SaveOptions.PrettyFormat.xml')
if pretty_format:
    self.assertTrue('<o:DocumentProperties>\r\n\t\t' + '<o:Revision>1</o:Revision>\r\n\t\t' + '<o:TotalTime>0</o:TotalTime>\r\n\t\t' + '<o:Pages>1</o:Pages>\r\n\t\t' + '<o:Words>0</o:Words>\r\n\t\t' + '<o:Characters>0</o:Characters>\r\n\t\t' + '<o:Lines>1</o:Lines>\r\n\t\t' + '<o:Paragraphs>1</o:Paragraphs>\r\n\t\t' + '<o:CharactersWithSpaces>0</o:CharactersWithSpaces>\r\n\t\t' + '<o:Version>11.5606</o:Version>\r\n\t' + '</o:DocumentProperties>' in file_contents)
else:
    self.assertTrue('<o:DocumentProperties><o:Revision>1</o:Revision><o:TotalTime>0</o:TotalTime><o:Pages>1</o:Pages>' + '<o:Words>0</o:Words><o:Characters>0</o:Characters><o:Lines>1</o:Lines><o:Paragraphs>1</o:Paragraphs>' + '<o:CharactersWithSpaces>0</o:CharactersWithSpaces><o:Version>11.5606</o:Version></o:DocumentProperties>' in file_contents)

Shows how to manage memory optimization.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
# Create a "WordML2003SaveOptions" object to pass to the document's "Save" method
# to modify how we save the document to the WordML save format.
options = aw.saving.WordML2003SaveOptions()
# Set the "MemoryOptimization" flag to "true" to decrease memory consumption
# during the document's saving operation at the cost of a longer saving time.
# Set the "MemoryOptimization" flag to "false" to save the document normally.
options.memory_optimization = memory_optimization
doc.save(file_name=ARTIFACTS_DIR + 'WordML2003SaveOptions.MemoryOptimization.xml', save_options=options)

See Also

TxtSaveOptionsBase class XamlFixedSaveOptions class