OoxmlSaveOptions class

OoxmlSaveOptions class

Can be used to specify additional options when saving a document into the SaveFormat.Docx, SaveFormat.Docm, SaveFormat.Dotx, SaveFormat.Dotm or SaveFormat.FlatOpc format. To learn more, visit the Specify Save Options documentation article.

Inheritance: OoxmlSaveOptions → SaveOptions

Constructors

NameDescription
OoxmlSaveOptions()Initializes a new instance of this class that can be used to save a document in the SaveFormat.Docx format.
OoxmlSaveOptions(saveFormat)Initializes a new instance of this class that can be used to save a document in the SaveFormat.Docx, SaveFormat.Docm, SaveFormat.Dotx, SaveFormat.Dotm or SaveFormat.FlatOpc format.

Properties

NameDescription
allowEmbeddingPostScriptFontsGets 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)
complianceSpecifies the OOXML version for the output document. The default value is OoxmlCompliance.Ecma376_2006.
compressionLevelSpecifies the compression level used to save document. The default value is CompressionLevel.Normal.
defaultTemplateGets or sets path to default template (including filename). Default value for this property is empty string .
(Inherited from SaveOptions)
digitalSignatureDetailsGets or sets DigitalSignatureDetails object used to sign a document.
dml3DEffectsRenderingModeGets or sets a value determining how 3D effects are rendered.
(Inherited from SaveOptions)
dmlEffectsRenderingModeGets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions)
dmlRenderingModeGets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions)
exportGeneratorNameWhen true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
(Inherited from SaveOptions)
imlRenderingModeGets or sets a value determining how ink (InkML) objects are rendered.
(Inherited from SaveOptions)
keepLegacyControlCharsKeeps original representation of legacy control characters.
memoryOptimizationGets 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/sets a password to encrypt document using ECMA376 Standard encryption algorithm.
prettyFormatWhen true, pretty formats output where applicable. Default value is false.
(Inherited from SaveOptions)
saveFormatSpecifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.Docx, SaveFormat.Docm, SaveFormat.Dotx, SaveFormat.Dotm or SaveFormat.FlatOpc.
tempFolderSpecifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
(Inherited from SaveOptions)
updateAmbiguousTextFontDetermines whether the font attributes will be changed according to the character code being used.
(Inherited from SaveOptions)
updateCreatedTimePropertyGets or sets a value determining whether the BuiltInDocumentProperties.createdTime property is updated before saving. Default value is false;
(Inherited from SaveOptions)
updateFieldsGets 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)
updateLastPrintedPropertyGets or sets a value determining whether the BuiltInDocumentProperties.lastPrinted property is updated before saving.
(Inherited from SaveOptions)
updateLastSavedTimePropertyGets or sets a value determining whether the BuiltInDocumentProperties.lastSavedTime property is updated before saving.
(Inherited from SaveOptions)
useAntiAliasingGets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions)
useHighQualityRenderingGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions)
zip64ModeSpecifies whether or not to use ZIP64 format extensions for the output document. The default value is Zip64Mode.Never.

Methods

NameDescription
createSaveOptions(saveFormat)Creates a save options object of a class suitable for the specified save format.
(Inherited from SaveOptions)
createSaveOptions(fileName)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 an OOXML compliance specification for a saved document to adhere to.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

// If we configure compatibility options to comply with Microsoft Word 2003,
// inserting an image will define its shape using VML.
doc.compatibilityOptions.optimizeFor(aw.Settings.MsWordVersion.Word2003);
builder.insertImage(base.imageDir + "Transparent background logo.png");

expect(doc.getShape(0, true).markupLanguage).toEqual(aw.Drawing.ShapeMarkupLanguage.Vml);

// The "ISO/IEC 29500:2008" OOXML standard does not support VML shapes.
// If we set the "Compliance" property of the SaveOptions object to "OoxmlCompliance.Iso29500_2008_Strict",
// any document we save while passing this object will have to follow that standard. 
let saveOptions = new aw.Saving.OoxmlSaveOptions();
saveOptions.compliance = aw.Saving.OoxmlCompliance.Iso29500_2008_Strict;
saveOptions.saveFormat = aw.SaveFormat.Docx;

doc.save(base.artifactsDir + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions);

// Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard.
doc = new aw.Document(base.artifactsDir + "OoxmlSaveOptions.Iso29500Strict.docx");

expect(doc.getShape(0, true).markupLanguage).toEqual(aw.Drawing.ShapeMarkupLanguage.Dml);

See Also

OoxmlCompliance enumeration OutlineOptions class