**Inheritance:** java.lang.Object, [com.aspose.words.SaveOptions](../../com.aspose.words/saveoptions/) ``` public class OoxmlSaveOptions extends SaveOptions ``` Can be used to specify additional options when saving a document into the [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX), [SaveFormat.DOCM](../../com.aspose.words/saveformat/\#DOCM), [SaveFormat.DOTX](../../com.aspose.words/saveformat/\#DOTX), [SaveFormat.DOTM](../../com.aspose.words/saveformat/\#DOTM) or [SaveFormat.FLAT\_OPC](../../com.aspose.words/saveformat/\#FLAT-OPC) format. To learn more, visit the [ Specify Save Options ][Specify Save Options] documentation article. **Examples:** Shows how to set an OOXML compliance specification for a saved document to adhere to. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If we configure compatibility options to comply with Microsoft Word 2003, // inserting an image will define its shape using VML. doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // 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. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); ``` [Specify Save Options]: https://docs.aspose.com/words/java/specify-save-options/ ## Constructors | Constructor | Description | | --- | --- | | [OoxmlSaveOptions()](#OoxmlSaveOptions) | Initializes a new instance of this class that can be used to save a document in the [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX) format. | | [OoxmlSaveOptions(int saveFormat)](#OoxmlSaveOptions-int) | Initializes a new instance of this class. | ## Methods | Method | Description | | --- | --- | | [createSaveOptions(int saveFormat)](#createSaveOptions-int) | | | [createSaveOptions(String fileName)](#createSaveOptions-java.lang.String) | Creates a save options object of a class suitable for the file extension specified in the given file name. | | [getAllowEmbeddingPostScriptFonts()](#getAllowEmbeddingPostScriptFonts) | Gets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. | | [getCompliance()](#getCompliance) | Specifies the OOXML version for the output document. | | [getCompressionLevel()](#getCompressionLevel) | Specifies the compression level used to save document. | | [getCustomTimeZoneInfo()](#getCustomTimeZoneInfo) | Gets custom local time zone used for date/time fields. | | [getDefaultTemplate()](#getDefaultTemplate) | Gets path to default template (including filename). | | [getDigitalSignatureDetails()](#getDigitalSignatureDetails) | Gets [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) object used to sign a document. | | [getDml3DEffectsRenderingMode()](#getDml3DEffectsRenderingMode) | Gets a value determining how 3D effects are rendered. | | [getDmlEffectsRenderingMode()](#getDmlEffectsRenderingMode) | Gets a value determining how DrawingML effects are rendered. | | [getDmlRenderingMode()](#getDmlRenderingMode) | Gets a value determining how DrawingML shapes are rendered. | | [getExportGeneratorName()](#getExportGeneratorName) | When true , causes the name and version of Aspose.Words to be embedded into produced files. | | [getImlRenderingMode()](#getImlRenderingMode) | Gets a value determining how ink (InkML) objects are rendered. | | [getKeepLegacyControlChars()](#getKeepLegacyControlChars) | Keeps original representation of legacy control characters. | | [getMemoryOptimization()](#getMemoryOptimization) | Gets value determining if memory optimization should be performed before saving the document. | | [getPassword()](#getPassword) | Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm. | | [getPrettyFormat()](#getPrettyFormat) | When true , pretty formats output where applicable. | | [getProgressCallback()](#getProgressCallback) | Called during saving a document and accepts data about saving progress. | | [getSaveFormat()](#getSaveFormat) | Specifies the format in which the document will be saved if this save options object is used. | | [getTempFolder()](#getTempFolder) | Specifies the folder for temporary files used when saving to a DOC or DOCX file. | | [getUpdateAmbiguousTextFont()](#getUpdateAmbiguousTextFont) | Determines whether the font attributes will be changed according to the character code being used. | | [getUpdateCreatedTimeProperty()](#getUpdateCreatedTimeProperty) | Gets a value determining whether the [BuiltInDocumentProperties.getCreatedTime()](../../com.aspose.words/builtindocumentproperties/\#getCreatedTime) / [BuiltInDocumentProperties.setCreatedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setCreatedTime-java.util.Date) property is updated before saving. | | [getUpdateFields()](#getUpdateFields) | Gets a value determining if fields of certain types should be updated before saving the document to a fixed page format. | | [getUpdateLastPrintedProperty()](#getUpdateLastPrintedProperty) | Gets a value determining whether the [BuiltInDocumentProperties.getLastPrinted()](../../com.aspose.words/builtindocumentproperties/\#getLastPrinted) / [BuiltInDocumentProperties.setLastPrinted(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastPrinted-java.util.Date) property is updated before saving. | | [getUpdateLastSavedTimeProperty()](#getUpdateLastSavedTimeProperty) | Gets a value determining whether the [BuiltInDocumentProperties.getLastSavedTime()](../../com.aspose.words/builtindocumentproperties/\#getLastSavedTime) / [BuiltInDocumentProperties.setLastSavedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastSavedTime-java.util.Date) property is updated before saving. | | [getUpdateOleControlImages()](#getUpdateOleControlImages) | Gets a value determining whether OLE controls presentation image will be updated. | | [getUseAntiAliasing()](#getUseAntiAliasing) | Gets a value determining whether or not to use anti-aliasing for rendering. | | [getUseHighQualityRendering()](#getUseHighQualityRendering) | Gets a value determining whether or not to use high quality (i.e. | | [getZip64Mode()](#getZip64Mode) | Specifies whether or not to use ZIP64 format extensions for the output document. | | [setAllowEmbeddingPostScriptFonts(boolean value)](#setAllowEmbeddingPostScriptFonts-boolean) | Sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. | | [setCompliance(int value)](#setCompliance-int) | Specifies the OOXML version for the output document. | | [setCompressionLevel(int value)](#setCompressionLevel-int) | Specifies the compression level used to save document. | | [setCustomTimeZoneInfo(TimeZone value)](#setCustomTimeZoneInfo-java.util.TimeZone) | | | [setDefaultTemplate(String value)](#setDefaultTemplate-java.lang.String) | Sets path to default template (including filename). | | [setDigitalSignatureDetails(DigitalSignatureDetails value)](#setDigitalSignatureDetails-com.aspose.words.DigitalSignatureDetails) | Sets [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) object used to sign a document. | | [setDml3DEffectsRenderingMode(int value)](#setDml3DEffectsRenderingMode-int) | Sets a value determining how 3D effects are rendered. | | [setDmlEffectsRenderingMode(int value)](#setDmlEffectsRenderingMode-int) | Sets a value determining how DrawingML effects are rendered. | | [setDmlRenderingMode(int value)](#setDmlRenderingMode-int) | Sets a value determining how DrawingML shapes are rendered. | | [setExportGeneratorName(boolean value)](#setExportGeneratorName-boolean) | When true , causes the name and version of Aspose.Words to be embedded into produced files. | | [setImlRenderingMode(int value)](#setImlRenderingMode-int) | Sets a value determining how ink (InkML) objects are rendered. | | [setKeepLegacyControlChars(boolean value)](#setKeepLegacyControlChars-boolean) | Keeps original representation of legacy control characters. | | [setMemoryOptimization(boolean value)](#setMemoryOptimization-boolean) | Sets value determining if memory optimization should be performed before saving the document. | | [setPassword(String value)](#setPassword-java.lang.String) | Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm. | | [setPrettyFormat(boolean value)](#setPrettyFormat-boolean) | When true , pretty formats output where applicable. | | [setProgressCallback(IDocumentSavingCallback value)](#setProgressCallback-com.aspose.words.IDocumentSavingCallback) | Called during saving a document and accepts data about saving progress. | | [setSaveFormat(int value)](#setSaveFormat-int) | Specifies the format in which the document will be saved if this save options object is used. | | [setTempFolder(String value)](#setTempFolder-java.lang.String) | Specifies the folder for temporary files used when saving to a DOC or DOCX file. | | [setUpdateAmbiguousTextFont(boolean value)](#setUpdateAmbiguousTextFont-boolean) | Determines whether the font attributes will be changed according to the character code being used. | | [setUpdateCreatedTimeProperty(boolean value)](#setUpdateCreatedTimeProperty-boolean) | Sets a value determining whether the [BuiltInDocumentProperties.getCreatedTime()](../../com.aspose.words/builtindocumentproperties/\#getCreatedTime) / [BuiltInDocumentProperties.setCreatedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setCreatedTime-java.util.Date) property is updated before saving. | | [setUpdateFields(boolean value)](#setUpdateFields-boolean) | Sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. | | [setUpdateLastPrintedProperty(boolean value)](#setUpdateLastPrintedProperty-boolean) | Sets a value determining whether the [BuiltInDocumentProperties.getLastPrinted()](../../com.aspose.words/builtindocumentproperties/\#getLastPrinted) / [BuiltInDocumentProperties.setLastPrinted(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastPrinted-java.util.Date) property is updated before saving. | | [setUpdateLastSavedTimeProperty(boolean value)](#setUpdateLastSavedTimeProperty-boolean) | Sets a value determining whether the [BuiltInDocumentProperties.getLastSavedTime()](../../com.aspose.words/builtindocumentproperties/\#getLastSavedTime) / [BuiltInDocumentProperties.setLastSavedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastSavedTime-java.util.Date) property is updated before saving. | | [setUpdateOleControlImages(boolean value)](#setUpdateOleControlImages-boolean) | Sets a value determining whether OLE controls presentation image will be updated. | | [setUseAntiAliasing(boolean value)](#setUseAntiAliasing-boolean) | Sets a value determining whether or not to use anti-aliasing for rendering. | | [setUseHighQualityRendering(boolean value)](#setUseHighQualityRendering-boolean) | Sets a value determining whether or not to use high quality (i.e. | | [setZip64Mode(int value)](#setZip64Mode-int) | Specifies whether or not to use ZIP64 format extensions for the output document. | ### OoxmlSaveOptions() {#OoxmlSaveOptions} ``` public OoxmlSaveOptions() ``` Initializes a new instance of this class that can be used to save a document in the [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX) format. **Examples:** Shows how to set an OOXML compliance specification for a saved document to adhere to. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If we configure compatibility options to comply with Microsoft Word 2003, // inserting an image will define its shape using VML. doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // 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. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); ``` ### OoxmlSaveOptions(int saveFormat) {#OoxmlSaveOptions-int} ``` public OoxmlSaveOptions(int saveFormat) ``` Initializes a new instance of this class. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | saveFormat | int | | ### createSaveOptions(int saveFormat) {#createSaveOptions-int} ``` public static SaveOptions createSaveOptions(int saveFormat) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | saveFormat | int | | **Returns:** [SaveOptions](../../com.aspose.words/saveoptions/) ### createSaveOptions(String fileName) {#createSaveOptions-java.lang.String} ``` public static SaveOptions createSaveOptions(String fileName) ``` Creates a save options object of a class suitable for the file extension specified in the given file name. **Examples:** Shows how to set a default template for documents that do not have attached templates. ``` Document doc = new Document(); // Enable automatic style updating, but do not attach a template document. doc.setAutomaticallyUpdateStyles(true); Assert.assertEquals("", doc.getAttachedTemplate()); // Since there is no template document, the document had nowhere to track style changes. // Use a SaveOptions object to automatically set a template // if a document that we are saving does not have one. SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx"); options.setDefaultTemplate(getMyDir() + "Business brochure.dotx"); doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | fileName | java.lang.String | The extension of this file name determines the class of the save options object to create. | **Returns:** [SaveOptions](../../com.aspose.words/saveoptions/) - An object of a class that derives from [SaveOptions](../../com.aspose.words/saveoptions/). ### getAllowEmbeddingPostScriptFonts() {#getAllowEmbeddingPostScriptFonts} ``` public boolean getAllowEmbeddingPostScriptFonts() ``` Gets 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 . **Remarks:** Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. This option only works when [FontInfoCollection.getEmbedTrueTypeFonts()](../../com.aspose.words/fontinfocollection/\#getEmbedTrueTypeFonts) / [FontInfoCollection.setEmbedTrueTypeFonts(boolean)](../../com.aspose.words/fontinfocollection/\#setEmbedTrueTypeFonts-boolean) of the [DocumentBase.getFontInfos()](../../com.aspose.words/documentbase/\#getFontInfos) property is set to true . **Examples:** Shows how to save the document with PostScript font. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setName("PostScriptFont"); builder.writeln("Some text with PostScript font."); // Load the font with PostScript to use in the document. MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf"))); doc.setFontSettings(new FontSettings()); doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf}); // Embed TrueType fonts. doc.getFontInfos().setEmbedTrueTypeFonts(true); // Allow embedding PostScript fonts while embedding TrueType fonts. // Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX); saveOptions.setAllowEmbeddingPostScriptFonts(true); doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions); ``` **Returns:** boolean - A boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. ### getCompliance() {#getCompliance} ``` public int getCompliance() ``` Specifies the OOXML version for the output document. The default value is [OoxmlCompliance.ECMA\_376\_2006](../../com.aspose.words/ooxmlcompliance/\#ECMA-376-2006). **Examples:** Shows how to set an OOXML compliance specification for a saved document to adhere to. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If we configure compatibility options to comply with Microsoft Word 2003, // inserting an image will define its shape using VML. doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // 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. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); ``` Shows how to configure a list to restart numbering at each section. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); doc.getLists().add(ListTemplate.NUMBER_DEFAULT); List list = doc.getLists().get(0); list.isRestartAtEachSection(restartListAtEachSection); // The "IsRestartAtEachSection" property will only be applicable when // the document's OOXML compliance level is to a standard that is newer than "OoxmlComplianceCore.Ecma376". OoxmlSaveOptions options = new OoxmlSaveOptions(); { options.setCompliance(OoxmlCompliance.ISO_29500_2008_TRANSITIONAL); } builder.getListFormat().setList(list); builder.writeln("List item 1"); builder.writeln("List item 2"); builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE); builder.writeln("List item 3"); builder.writeln("List item 4"); doc.save(getArtifactsDir() + "OoxmlSaveOptions.RestartingDocumentList.docx", options); doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.RestartingDocumentList.docx"); Assert.assertEquals(restartListAtEachSection, doc.getLists().get(0).isRestartAtEachSection()); ``` Shows how to insert DML shapes into a document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Below are two wrapping types that shapes may have. // 1 - Floating: builder.insertShape(ShapeType.TOP_CORNERS_ROUNDED, RelativeHorizontalPosition.PAGE, 100.0, RelativeVerticalPosition.PAGE, 100.0, 50.0, 50.0, WrapType.NONE); // 2 - Inline: builder.insertShape(ShapeType.DIAGONAL_CORNERS_ROUNDED, 50.0, 50.0); // If you need to create "non-primitive" shapes, such as SingleCornerSnipped, TopCornersSnipped, DiagonalCornersSnipped, // TopCornersOneRoundedOneSnipped, SingleCornerRounded, TopCornersRounded, or DiagonalCornersRounded, // then save the document with "Strict" or "Transitional" compliance, which allows saving shape as DML. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_TRANSITIONAL); doc.save(getArtifactsDir() + "Shape.ShapeInsertion.docx", saveOptions); ``` **Returns:** int - The corresponding int value. The returned value is one of [OoxmlCompliance](../../com.aspose.words/ooxmlcompliance/) constants. ### getCompressionLevel() {#getCompressionLevel} ``` public int getCompressionLevel() ``` Specifies the compression level used to save document. The default value is [CompressionLevel.NORMAL](../../com.aspose.words/compressionlevel/\#NORMAL). **Examples:** Shows how to specify the compression level to use while saving an OOXML document. ``` Document doc = new Document(getMyDir() + "Big document.docx"); // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object // and then pass it to the document's saving method to modify how we save the document. // Set the "CompressionLevel" property to "CompressionLevel.Maximum" to apply the strongest and slowest compression. // Set the "CompressionLevel" property to "CompressionLevel.Normal" to apply // the default compression that Aspose.Words uses while saving OOXML documents. // Set the "CompressionLevel" property to "CompressionLevel.Fast" to apply a faster and weaker compression. // Set the "CompressionLevel" property to "CompressionLevel.SuperFast" to apply // the default compression that Microsoft Word uses. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX); saveOptions.setCompressionLevel(compressionLevel); StopWatch st = new StopWatch(); st.start(); doc.save(getArtifactsDir() + "OoxmlSaveOptions.DocumentCompression.docx", saveOptions); st.stop(); File fileInfo = new File(getArtifactsDir() + "OoxmlSaveOptions.DocumentCompression.docx"); System.out.println(MessageFormat.format("Saving operation done using the \"{0}\" compression level:", compressionLevel)); System.out.println(MessageFormat.format("\tDuration:\t{0}", st.getTime())); System.out.println(MessageFormat.format("\tFile Size:\t{0} bytes", fileInfo.length())); ``` **Returns:** int - The corresponding int value. The returned value is one of [CompressionLevel](../../com.aspose.words/compressionlevel/) constants. ### getCustomTimeZoneInfo() {#getCustomTimeZoneInfo} ``` public TimeZone getCustomTimeZoneInfo() ``` Gets custom local time zone used for date/time fields. **Remarks:** This option is available in either .Net framework starting from 3.5 version or .Net Standard. By default, Aspose.Words uses system local time zone when writes date/time fields, this option allows to set custom value. **Returns:** java.util.TimeZone - Custom local time zone used for date/time fields. ### getDefaultTemplate() {#getDefaultTemplate} ``` public String getDefaultTemplate() ``` Gets path to default template (including filename). Default value for this property is **empty string**. **Remarks:** If specified, this path is used to load template when [Document.getAutomaticallyUpdateStyles()](../../com.aspose.words/document/\#getAutomaticallyUpdateStyles) / [Document.setAutomaticallyUpdateStyles(boolean)](../../com.aspose.words/document/\#setAutomaticallyUpdateStyles-boolean) is true , but [Document.getAttachedTemplate()](../../com.aspose.words/document/\#getAttachedTemplate) / [Document.setAttachedTemplate(java.lang.String)](../../com.aspose.words/document/\#setAttachedTemplate-java.lang.String) is empty. **Examples:** Shows how to set a default template for documents that do not have attached templates. ``` Document doc = new Document(); // Enable automatic style updating, but do not attach a template document. doc.setAutomaticallyUpdateStyles(true); Assert.assertEquals("", doc.getAttachedTemplate()); // Since there is no template document, the document had nowhere to track style changes. // Use a SaveOptions object to automatically set a template // if a document that we are saving does not have one. SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx"); options.setDefaultTemplate(getMyDir() + "Business brochure.dotx"); doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options); ``` **Returns:** java.lang.String - Path to default template (including filename). ### getDigitalSignatureDetails() {#getDigitalSignatureDetails} ``` public DigitalSignatureDetails getDigitalSignatureDetails() ``` Gets [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) object used to sign a document. **Examples:** Shows how to sign OOXML document. ``` Document doc = new Document(getMyDir() + "Document.docx"); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); SignOptions signOptions = new SignOptions(); signOptions.setComments("Some comments"); signOptions.setSignTime(new Date()); saveOptions.setDigitalSignatureDetails(new DigitalSignatureDetails( certificateHolder, signOptions)); doc.save(getArtifactsDir() + "OoxmlSaveOptions.DigitalSignature.docx", saveOptions); ``` **Returns:** [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) - [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) object used to sign a document. ### getDml3DEffectsRenderingMode() {#getDml3DEffectsRenderingMode} ``` public int getDml3DEffectsRenderingMode() ``` Gets a value determining how 3D effects are rendered. **Remarks:** The default value is [Dml3DEffectsRenderingMode.BASIC](../../com.aspose.words/dml3deffectsrenderingmode/\#BASIC). **Examples:** Shows how 3D effects are rendered. ``` Document doc = new Document(getMyDir() + "DrawingML shape 3D effects.docx"); RenderCallback warningCallback = new RenderCallback(); doc.setWarningCallback(warningCallback); PdfSaveOptions saveOptions = new PdfSaveOptions(); saveOptions.setDml3DEffectsRenderingMode(Dml3DEffectsRenderingMode.ADVANCED); doc.save(getArtifactsDir() + "PdfSaveOptions.Dml3DEffectsRenderingModeTest.pdf", saveOptions); ``` **Returns:** int - A value determining how 3D effects are rendered. The returned value is one of [Dml3DEffectsRenderingMode](../../com.aspose.words/dml3deffectsrenderingmode/) constants. ### getDmlEffectsRenderingMode() {#getDmlEffectsRenderingMode} ``` public int getDmlEffectsRenderingMode() ``` Gets a value determining how DrawingML effects are rendered. **Remarks:** The default value is [DmlEffectsRenderingMode.SIMPLIFIED](../../com.aspose.words/dmleffectsrenderingmode/\#SIMPLIFIED). This property is used when the document is exported to fixed page formats. **Examples:** Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF. ``` Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified" // to render a simplified version of DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to // render DrawingML effects with more accuracy and also with more processing cost. options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options); ``` **Returns:** int - A value determining how DrawingML effects are rendered. The returned value is one of [DmlEffectsRenderingMode](../../com.aspose.words/dmleffectsrenderingmode/) constants. ### getDmlRenderingMode() {#getDmlRenderingMode} ``` public int getDmlRenderingMode() ``` Gets a value determining how DrawingML shapes are rendered. **Remarks:** The default value is [DmlRenderingMode.FALLBACK](../../com.aspose.words/dmlrenderingmode/\#FALLBACK). This property is used when the document is exported to fixed page formats. **Examples:** Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF. ``` Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified" // to render a simplified version of DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to // render DrawingML effects with more accuracy and also with more processing cost. options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options); ``` Shows how to render fallback shapes when saving to PDF. ``` Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback" // to substitute DML shapes with their fallback shapes. // Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML" // to render the DML shapes themselves. options.setDmlRenderingMode(dmlRenderingMode); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options); ``` **Returns:** int - A value determining how DrawingML shapes are rendered. The returned value is one of [DmlRenderingMode](../../com.aspose.words/dmlrenderingmode/) constants. ### getExportGeneratorName() {#getExportGeneratorName} ``` public boolean getExportGeneratorName() ``` When true , causes the name and version of Aspose.Words to be embedded into produced files. Default value is true . **Examples:** Shows how to disable adding name and version of Aspose.Words into produced files. ``` Document doc = new Document(); // Use https://docs.aspose.com/words/net/generator-or-producer-name-included-in-output-documents/ to know how to check the result. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setExportGeneratorName(false); } doc.save(getArtifactsDir() + "OoxmlSaveOptions.ExportGeneratorName.docx", saveOptions); ``` **Returns:** boolean - The corresponding boolean value. ### getImlRenderingMode() {#getImlRenderingMode} ``` public int getImlRenderingMode() ``` Gets a value determining how ink (InkML) objects are rendered. **Remarks:** The default value is [ImlRenderingMode.INK\_ML](../../com.aspose.words/imlrenderingmode/\#INK-ML). This property is used when the document is exported to fixed page formats. **Examples:** Shows how to render Ink object. ``` Document doc = new Document(getMyDir() + "Ink object.docx"); // Set 'ImlRenderingMode.InkML' ignores fall-back shape of ink (InkML) object and renders InkML itself. // If the rendering result is unsatisfactory, // please use 'ImlRenderingMode.Fallback' to get a result similar to previous versions. ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG); { saveOptions.setImlRenderingMode(ImlRenderingMode.INK_ML); } doc.save(getArtifactsDir() + "ImageSaveOptions.RenderInkObject.jpeg", saveOptions); ``` **Returns:** int - A value determining how ink (InkML) objects are rendered. The returned value is one of [ImlRenderingMode](../../com.aspose.words/imlrenderingmode/) constants. ### getKeepLegacyControlChars() {#getKeepLegacyControlChars} ``` public boolean getKeepLegacyControlChars() ``` Keeps original representation of legacy control characters. **Examples:** Shows how to support legacy control characters when converting to .docx. ``` Document doc = new Document(getMyDir() + "Legacy control character.doc"); // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object // and then pass it to the document's saving method to modify how we save the document. // Set the "KeepLegacyControlChars" property to "true" to preserve // the "ShortDateTime" legacy character while saving. // Set the "KeepLegacyControlChars" property to "false" to remove // the "ShortDateTime" legacy character from the output document. OoxmlSaveOptions so = new OoxmlSaveOptions(SaveFormat.DOCX); so.setKeepLegacyControlChars(keepLegacyControlChars); doc.save(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx", so); doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx"); if (keepLegacyControlChars) Assert.assertEquals("date \\@ \"M/d/yyyy\"\f", doc.getFirstSection().getBody().getText()); else Assert.assertEquals("\f", doc.getFirstSection().getBody().getText()); ``` **Returns:** boolean - The corresponding boolean value. ### getMemoryOptimization() {#getMemoryOptimization} ``` public boolean getMemoryOptimization() ``` Gets value determining if memory optimization should be performed before saving the document. Default value for this property is false . **Remarks:** Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time. **Examples:** Shows an option to optimize memory consumption when rendering large documents to PDF. ``` Document doc = new Document(getMyDir() + "Rendering.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); // Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations // at the cost of increasing the duration of the operation. // Set the "MemoryOptimization" property to "false" to save the document as a PDF normally. saveOptions.setMemoryOptimization(memoryOptimization); doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions); ``` **Returns:** boolean - Value determining if memory optimization should be performed before saving the document. ### getPassword() {#getPassword} ``` public String getPassword() ``` Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm. **Remarks:** In order to save document without encryption this property should be null or empty string. **Examples:** Shows how to create a password encrypted Office Open XML document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello world!"); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setPassword("MyPassword"); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", saveOptions); // We will not be able to open this document with Microsoft Word or // Aspose.Words without providing the correct password. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx")); // Open the encrypted document by passing the correct password in a LoadOptions object. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", new LoadOptions("MyPassword")); Assert.assertEquals("Hello world!", doc.getText().trim()); ``` **Returns:** java.lang.String - The corresponding java.lang.String value. ### getPrettyFormat() {#getPrettyFormat} ``` public boolean getPrettyFormat() ``` When true , pretty formats output where applicable. Default value is false . **Remarks:** Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging. **Examples:** Shows how to enhance the readability of the raw code of a saved .html document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello world!"); HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML); { htmlOptions.setPrettyFormat(usePrettyFormat); } doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions); // Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters. String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8); if (usePrettyFormat) Assert.assertEquals( "\r\n" + "\t\r\n" + "\t\t\r\n" + "\t\t\r\n" + MessageFormat.format("\t\t\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) + "\t\t\r\n" + "\t\t\r\n" + "\t\r\n" + "\t\r\n" + "\t\t \r\n" + "\t\t\t \r\n" + "\t\t\t\tHello world!\r\n" + "\t\t\t\r\n" + "\t\t\t \r\n" + "\t\t\t\t \r\n" + "\t\t\t\r\n" + "\t\t\r\n" + "\t\r\n", html); else Assert.assertEquals( "" + "" + MessageFormat.format("", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) + "" + " Hello world!" + "  ", html); ``` **Returns:** boolean - The corresponding boolean value. ### getProgressCallback() {#getProgressCallback} ``` public IDocumentSavingCallback getProgressCallback() ``` Called during saving a document and accepts data about saving progress. **Remarks:** Progress is reported when saving to [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX), [SaveFormat.FLAT\_OPC](../../com.aspose.words/saveformat/\#FLAT-OPC), [SaveFormat.DOCM](../../com.aspose.words/saveformat/\#DOCM), [SaveFormat.DOTM](../../com.aspose.words/saveformat/\#DOTM), [SaveFormat.DOTX](../../com.aspose.words/saveformat/\#DOTX), [SaveFormat.DOC](../../com.aspose.words/saveformat/\#DOC), [SaveFormat.DOT](../../com.aspose.words/saveformat/\#DOT), [SaveFormat.HTML](../../com.aspose.words/saveformat/\#HTML), [SaveFormat.MHTML](../../com.aspose.words/saveformat/\#MHTML), [SaveFormat.EPUB](../../com.aspose.words/saveformat/\#EPUB), [SaveFormat.XAML\_FLOW](../../com.aspose.words/saveformat/\#XAML-FLOW), or [SaveFormat.XAML\_FLOW\_PACK](../../com.aspose.words/saveformat/\#XAML-FLOW-PACK). **Examples:** Shows how to manage a document while saving to html. ``` public void progressCallback(int saveFormat, String ext) throws Exception { Document doc = new Document(getMyDir() + "Big document.docx"); // Following formats are supported: Html, Mhtml, Epub. HtmlSaveOptions saveOptions = new HtmlSaveOptions(saveFormat); { saveOptions.setProgressCallback(new SavingProgressCallback()); } try { doc.save(getArtifactsDir() + MessageFormat.format("HtmlSaveOptions.ProgressCallback.{0}", ext), saveOptions); } catch (IllegalStateException exception) { Assert.assertTrue(exception.getMessage().contains("EstimatedProgress")); } } public static Object[][] progressCallbackDataProvider() throws Exception { return new Object[][] { {SaveFormat.HTML, "html"}, {SaveFormat.MHTML, "mhtml"}, {SaveFormat.EPUB, "epub"}, }; } /// /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds. /// public static class SavingProgressCallback implements IDocumentSavingCallback { /// /// Ctr. /// public SavingProgressCallback() { mSavingStartedAt = new Date(); } /// /// Callback method which called during document saving. /// /// Saving arguments. public void notify(DocumentSavingArgs args) { Date canceledAt = new Date(); long diff = canceledAt.getTime() - mSavingStartedAt.getTime(); long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff); if (ellapsedSeconds > MAX_DURATION) throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt)); } /// /// Date and time when document saving is started. /// private Date mSavingStartedAt; /// /// Maximum allowed duration in sec. /// private static final double MAX_DURATION = 0.01d; } ``` Shows how to manage a document while saving to docx. ``` public void progressCallback(int saveFormat, String ext) throws Exception { Document doc = new Document(getMyDir() + "Big document.docx"); // Following formats are supported: Docx, FlatOpc, Docm, Dotm, Dotx. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(saveFormat); { saveOptions.setProgressCallback(new SavingProgressCallback()); } try { doc.save(getArtifactsDir() + MessageFormat.format("OoxmlSaveOptions.ProgressCallback.{0}", ext), saveOptions); } catch (IllegalStateException exception) { Assert.assertTrue(exception.getMessage().contains("EstimatedProgress")); } } public static Object[][] progressCallbackDataProvider() throws Exception { return new Object[][] { {SaveFormat.DOCX, "docx"}, {SaveFormat.DOCM, "docm"}, {SaveFormat.DOTM, "dotm"}, {SaveFormat.DOTX, "dotx"}, {SaveFormat.FLAT_OPC, "flatopc"}, }; } /// /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds. /// public static class SavingProgressCallback implements IDocumentSavingCallback { /// /// Ctr. /// public SavingProgressCallback() { mSavingStartedAt = new Date(); } /// /// Callback method which called during document saving. /// /// Saving arguments. public void notify(DocumentSavingArgs args) { Date canceledAt = new Date(); long diff = canceledAt.getTime() - mSavingStartedAt.getTime(); long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff); if (ellapsedSeconds > MAX_DURATION) throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt)); } /// /// Date and time when document saving is started. /// private Date mSavingStartedAt; /// /// Maximum allowed duration in sec. /// private static final double MAX_DURATION = 0.01d; } ``` Shows how to manage a document while saving to xamlflow. ``` public void progressCallback(int saveFormat, String ext) throws Exception { Document doc = new Document(getMyDir() + "Big document.docx"); // Following formats are supported: XamlFlow, XamlFlowPack. XamlFlowSaveOptions saveOptions = new XamlFlowSaveOptions(saveFormat); { saveOptions.setProgressCallback(new SavingProgressCallback()); } try { doc.save(getArtifactsDir() + MessageFormat.format("XamlFlowSaveOptions.ProgressCallback.{0}", ext), saveOptions); } catch (IllegalStateException exception) { Assert.assertTrue(exception.getMessage().contains("EstimatedProgress")); } } public static Object[][] progressCallbackDataProvider() throws Exception { return new Object[][] { {SaveFormat.XAML_FLOW, "xamlflow"}, {SaveFormat.XAML_FLOW_PACK, "xamlflowpack"}, }; } /// /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds. /// public static class SavingProgressCallback implements IDocumentSavingCallback { /// /// Ctr. /// public SavingProgressCallback() { mSavingStartedAt = new Date(); } /// /// Callback method which called during document saving. /// /// Saving arguments. public void notify(DocumentSavingArgs args) { Date canceledAt = new Date(); long diff = canceledAt.getTime() - mSavingStartedAt.getTime(); long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff); if (ellapsedSeconds > MAX_DURATION) throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt)); } /// /// Date and time when document saving is started. /// private Date mSavingStartedAt; /// /// Maximum allowed duration in sec. /// private static final double MAX_DURATION = 0.01d; } ``` **Returns:** [IDocumentSavingCallback](../../com.aspose.words/idocumentsavingcallback/) - The corresponding [IDocumentSavingCallback](../../com.aspose.words/idocumentsavingcallback/) value. ### getSaveFormat() {#getSaveFormat} ``` public int getSaveFormat() ``` Specifies the format in which the document will be saved if this save options object is used. Can be [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX), [SaveFormat.DOCM](../../com.aspose.words/saveformat/\#DOCM), [SaveFormat.DOTX](../../com.aspose.words/saveformat/\#DOTX), [SaveFormat.DOTM](../../com.aspose.words/saveformat/\#DOTM) or [SaveFormat.FLAT\_OPC](../../com.aspose.words/saveformat/\#FLAT-OPC). **Examples:** Shows how to set an OOXML compliance specification for a saved document to adhere to. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If we configure compatibility options to comply with Microsoft Word 2003, // inserting an image will define its shape using VML. doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // 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. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); ``` **Returns:** int - The corresponding int value. The returned value is one of [SaveFormat](../../com.aspose.words/saveformat/) constants. ### getTempFolder() {#getTempFolder} ``` public String getTempFolder() ``` Specifies 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. **Returns:** java.lang.String - The corresponding java.lang.String value. ### getUpdateAmbiguousTextFont() {#getUpdateAmbiguousTextFont} ``` public boolean getUpdateAmbiguousTextFont() ``` Determines whether the font attributes will be changed according to the character code being used. **Examples:** Shows how to update the font to match the character code being used. ``` Document doc = new Document(getMyDir() + "Special symbol.docx"); Run run = doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0); System.out.println(run.getText()); // \u0e3f System.out.println(run.getFont().getName()); // Arial OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateAmbiguousTextFont(true); doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdateAmbiguousTextFont.docx", saveOptions); doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.UpdateAmbiguousTextFont.docx"); run = doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0); System.out.println(run.getText()); // \u0e3f System.out.println(run.getFont().getName()); // Angsana New ``` **Returns:** boolean - The corresponding boolean value. ### getUpdateCreatedTimeProperty() {#getUpdateCreatedTimeProperty} ``` public boolean getUpdateCreatedTimeProperty() ``` Gets a value determining whether the [BuiltInDocumentProperties.getCreatedTime()](../../com.aspose.words/builtindocumentproperties/\#getCreatedTime) / [BuiltInDocumentProperties.setCreatedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setCreatedTime-java.util.Date) property is updated before saving. Default value is false ; **Examples:** Shows how to update a document's "CreatedTime" property when saving. ``` Document doc = new Document(); Calendar calendar = Calendar.getInstance(); calendar.set(2019, 11, 20); doc.getBuiltInDocumentProperties().setCreatedTime(calendar.getTime()); // This flag determines whether the created time, which is a built-in property, is updated. // If so, then the date of the document's most recent save operation // with this SaveOptions object passed as a parameter is used as the created time. DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setUpdateCreatedTimeProperty(isUpdateCreatedTimeProperty); doc.save(getArtifactsDir() + "DocSaveOptions.UpdateCreatedTimeProperty.docx", saveOptions); ``` **Returns:** boolean - A value determining whether the [BuiltInDocumentProperties.getCreatedTime()](../../com.aspose.words/builtindocumentproperties/\#getCreatedTime) / [BuiltInDocumentProperties.setCreatedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setCreatedTime-java.util.Date) property is updated before saving. ### getUpdateFields() {#getUpdateFields} ``` public boolean getUpdateFields() ``` Gets 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 . **Remarks:** Allows to specify whether to mimic or not MS Word behavior. **Examples:** Shows how to update all the fields in a document immediately before saving it to PDF. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time. // We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()" // each time we need them to display accurate values. builder.write("Page "); builder.insertField("PAGE", ""); builder.write(" of "); builder.insertField("NUMPAGES", ""); builder.insertBreak(BreakType.PAGE_BREAK); builder.writeln("Hello World!"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "UpdateFields" property to "false" to not update all the fields in a document right before a save operation. // This is the preferable option if we know that all our fields will be up to date before saving. // Set the "UpdateFields" property to "true" to iterate through all the document // fields and update them before we save it as a PDF. This will make sure that all the fields will display // the most accurate values in the PDF. options.setUpdateFields(updateFields); // We can clone PdfSaveOptions objects. Assert.assertNotSame(options, options.deepClone()); doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options); ``` **Returns:** boolean - A value determining if fields of certain types should be updated before saving the document to a fixed page format. ### getUpdateLastPrintedProperty() {#getUpdateLastPrintedProperty} ``` public boolean getUpdateLastPrintedProperty() ``` Gets a value determining whether the [BuiltInDocumentProperties.getLastPrinted()](../../com.aspose.words/builtindocumentproperties/\#getLastPrinted) / [BuiltInDocumentProperties.setLastPrinted(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastPrinted-java.util.Date) property is updated before saving. **Examples:** Shows how to update a document's "Last printed" property when saving. ``` Document doc = new Document(); Calendar calendar = Calendar.getInstance(); calendar.set(2019, 11, 20); doc.getBuiltInDocumentProperties().setLastPrinted(calendar.getTime()); // This flag determines whether the last printed date, which is a built-in property, is updated. // If so, then the date of the document's most recent save operation // with this SaveOptions object passed as a parameter is used as the print date. DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty); // In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed. // It can also be displayed in the document's body by using a PRINTDATE field. doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions); ``` **Returns:** boolean - A value determining whether the [BuiltInDocumentProperties.getLastPrinted()](../../com.aspose.words/builtindocumentproperties/\#getLastPrinted) / [BuiltInDocumentProperties.setLastPrinted(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastPrinted-java.util.Date) property is updated before saving. ### getUpdateLastSavedTimeProperty() {#getUpdateLastSavedTimeProperty} ``` public boolean getUpdateLastSavedTimeProperty() ``` Gets a value determining whether the [BuiltInDocumentProperties.getLastSavedTime()](../../com.aspose.words/builtindocumentproperties/\#getLastSavedTime) / [BuiltInDocumentProperties.setLastSavedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastSavedTime-java.util.Date) property is updated before saving. **Examples:** Shows how to determine whether to preserve the document's "Last saved time" property when saving. ``` Document doc = new Document(getMyDir() + "Document.docx"); // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object // and then pass it to the document's saving method to modify how we save the document. // Set the "UpdateLastSavedTimeProperty" property to "true" to // set the output document's "Last saved time" built-in property to the current date/time. // Set the "UpdateLastSavedTimeProperty" property to "false" to // preserve the original value of the input document's "Last saved time" built-in property. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty); doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.docx", saveOptions); ``` **Returns:** boolean - A value determining whether the [BuiltInDocumentProperties.getLastSavedTime()](../../com.aspose.words/builtindocumentproperties/\#getLastSavedTime) / [BuiltInDocumentProperties.setLastSavedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastSavedTime-java.util.Date) property is updated before saving. ### getUpdateOleControlImages() {#getUpdateOleControlImages} ``` public boolean getUpdateOleControlImages() ``` Gets a value determining whether OLE controls presentation image will be updated. **Returns:** boolean - A value determining whether OLE controls presentation image will be updated. ### getUseAntiAliasing() {#getUseAntiAliasing} ``` public boolean getUseAntiAliasing() ``` Gets a value determining whether or not to use anti-aliasing for rendering. **Remarks:** The default value is false . When this value is set to true anti-aliasing is used for rendering. This property is used when the document is exported to the following formats: [SaveFormat.TIFF](../../com.aspose.words/saveformat/\#TIFF), [SaveFormat.PNG](../../com.aspose.words/saveformat/\#PNG), [SaveFormat.BMP](../../com.aspose.words/saveformat/\#BMP), [SaveFormat.JPEG](../../com.aspose.words/saveformat/\#JPEG), [SaveFormat.EMF](../../com.aspose.words/saveformat/\#EMF). When the document is exported to the [SaveFormat.HTML](../../com.aspose.words/saveformat/\#HTML), [SaveFormat.MHTML](../../com.aspose.words/saveformat/\#MHTML), [SaveFormat.EPUB](../../com.aspose.words/saveformat/\#EPUB), [SaveFormat.AZW\_3](../../com.aspose.words/saveformat/\#AZW-3) or [SaveFormat.MOBI](../../com.aspose.words/saveformat/\#MOBI) formats this option is used for raster images. **Examples:** Shows how to improve the quality of a rendered document with SaveOptions. ``` Document doc = new Document(getMyDir() + "Rendering.docx"); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options); ``` **Returns:** boolean - A value determining whether or not to use anti-aliasing for rendering. ### getUseHighQualityRendering() {#getUseHighQualityRendering} ``` public boolean getUseHighQualityRendering() ``` Gets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. **Remarks:** The default value is false . This property is used when the document is exported to image formats: [SaveFormat.TIFF](../../com.aspose.words/saveformat/\#TIFF), [SaveFormat.PNG](../../com.aspose.words/saveformat/\#PNG), [SaveFormat.BMP](../../com.aspose.words/saveformat/\#BMP), [SaveFormat.JPEG](../../com.aspose.words/saveformat/\#JPEG), [SaveFormat.EMF](../../com.aspose.words/saveformat/\#EMF). **Examples:** Shows how to improve the quality of a rendered document with SaveOptions. ``` Document doc = new Document(getMyDir() + "Rendering.docx"); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options); ``` **Returns:** boolean - A value determining whether or not to use high quality (i.e. ### getZip64Mode() {#getZip64Mode} ``` public int getZip64Mode() ``` Specifies whether or not to use ZIP64 format extensions for the output document. The default value is [Zip64Mode.NEVER](../../com.aspose.words/zip64mode/\#NEVER). **Examples:** Shows how to use ZIP64 format extensions. ``` Random random = new Random(); DocumentBuilder builder = new DocumentBuilder(); for (int i = 0; i < 10000; i++) { BufferedImage bmp = new BufferedImage(5, 5, BufferedImage.TYPE_INT_ARGB); Graphics2D g = bmp.createGraphics(); g.setColor(new Color(random.nextInt(254), random.nextInt(254), random.nextInt(254))); g.drawImage(bmp, 0, 0, null); g.dispose(); builder.insertImage(bmp); } OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setZip64Mode(Zip64Mode.ALWAYS); builder.getDocument().save(getArtifactsDir() + "OoxmlSaveOptions.Zip64ModeOption.docx", saveOptions); ``` **Returns:** int - The corresponding int value. The returned value is one of [Zip64Mode](../../com.aspose.words/zip64mode/) constants. ### setAllowEmbeddingPostScriptFonts(boolean value) {#setAllowEmbeddingPostScriptFonts-boolean} ``` public void setAllowEmbeddingPostScriptFonts(boolean value) ``` 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 . **Remarks:** Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. This option only works when [FontInfoCollection.getEmbedTrueTypeFonts()](../../com.aspose.words/fontinfocollection/\#getEmbedTrueTypeFonts) / [FontInfoCollection.setEmbedTrueTypeFonts(boolean)](../../com.aspose.words/fontinfocollection/\#setEmbedTrueTypeFonts-boolean) of the [DocumentBase.getFontInfos()](../../com.aspose.words/documentbase/\#getFontInfos) property is set to true . **Examples:** Shows how to save the document with PostScript font. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setName("PostScriptFont"); builder.writeln("Some text with PostScript font."); // Load the font with PostScript to use in the document. MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf"))); doc.setFontSettings(new FontSettings()); doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf}); // Embed TrueType fonts. doc.getFontInfos().setEmbedTrueTypeFonts(true); // Allow embedding PostScript fonts while embedding TrueType fonts. // Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX); saveOptions.setAllowEmbeddingPostScriptFonts(true); doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. | ### setCompliance(int value) {#setCompliance-int} ``` public void setCompliance(int value) ``` Specifies the OOXML version for the output document. The default value is [OoxmlCompliance.ECMA\_376\_2006](../../com.aspose.words/ooxmlcompliance/\#ECMA-376-2006). **Examples:** Shows how to set an OOXML compliance specification for a saved document to adhere to. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If we configure compatibility options to comply with Microsoft Word 2003, // inserting an image will define its shape using VML. doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // 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. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); ``` Shows how to configure a list to restart numbering at each section. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); doc.getLists().add(ListTemplate.NUMBER_DEFAULT); List list = doc.getLists().get(0); list.isRestartAtEachSection(restartListAtEachSection); // The "IsRestartAtEachSection" property will only be applicable when // the document's OOXML compliance level is to a standard that is newer than "OoxmlComplianceCore.Ecma376". OoxmlSaveOptions options = new OoxmlSaveOptions(); { options.setCompliance(OoxmlCompliance.ISO_29500_2008_TRANSITIONAL); } builder.getListFormat().setList(list); builder.writeln("List item 1"); builder.writeln("List item 2"); builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE); builder.writeln("List item 3"); builder.writeln("List item 4"); doc.save(getArtifactsDir() + "OoxmlSaveOptions.RestartingDocumentList.docx", options); doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.RestartingDocumentList.docx"); Assert.assertEquals(restartListAtEachSection, doc.getLists().get(0).isRestartAtEachSection()); ``` Shows how to insert DML shapes into a document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Below are two wrapping types that shapes may have. // 1 - Floating: builder.insertShape(ShapeType.TOP_CORNERS_ROUNDED, RelativeHorizontalPosition.PAGE, 100.0, RelativeVerticalPosition.PAGE, 100.0, 50.0, 50.0, WrapType.NONE); // 2 - Inline: builder.insertShape(ShapeType.DIAGONAL_CORNERS_ROUNDED, 50.0, 50.0); // If you need to create "non-primitive" shapes, such as SingleCornerSnipped, TopCornersSnipped, DiagonalCornersSnipped, // TopCornersOneRoundedOneSnipped, SingleCornerRounded, TopCornersRounded, or DiagonalCornersRounded, // then save the document with "Strict" or "Transitional" compliance, which allows saving shape as DML. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_TRANSITIONAL); doc.save(getArtifactsDir() + "Shape.ShapeInsertion.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | The corresponding int value. The value must be one of [OoxmlCompliance](../../com.aspose.words/ooxmlcompliance/) constants. | ### setCompressionLevel(int value) {#setCompressionLevel-int} ``` public void setCompressionLevel(int value) ``` Specifies the compression level used to save document. The default value is [CompressionLevel.NORMAL](../../com.aspose.words/compressionlevel/\#NORMAL). **Examples:** Shows how to specify the compression level to use while saving an OOXML document. ``` Document doc = new Document(getMyDir() + "Big document.docx"); // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object // and then pass it to the document's saving method to modify how we save the document. // Set the "CompressionLevel" property to "CompressionLevel.Maximum" to apply the strongest and slowest compression. // Set the "CompressionLevel" property to "CompressionLevel.Normal" to apply // the default compression that Aspose.Words uses while saving OOXML documents. // Set the "CompressionLevel" property to "CompressionLevel.Fast" to apply a faster and weaker compression. // Set the "CompressionLevel" property to "CompressionLevel.SuperFast" to apply // the default compression that Microsoft Word uses. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX); saveOptions.setCompressionLevel(compressionLevel); StopWatch st = new StopWatch(); st.start(); doc.save(getArtifactsDir() + "OoxmlSaveOptions.DocumentCompression.docx", saveOptions); st.stop(); File fileInfo = new File(getArtifactsDir() + "OoxmlSaveOptions.DocumentCompression.docx"); System.out.println(MessageFormat.format("Saving operation done using the \"{0}\" compression level:", compressionLevel)); System.out.println(MessageFormat.format("\tDuration:\t{0}", st.getTime())); System.out.println(MessageFormat.format("\tFile Size:\t{0} bytes", fileInfo.length())); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | The corresponding int value. The value must be one of [CompressionLevel](../../com.aspose.words/compressionlevel/) constants. | ### setCustomTimeZoneInfo(TimeZone value) {#setCustomTimeZoneInfo-java.util.TimeZone} ``` public void setCustomTimeZoneInfo(TimeZone value) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.util.TimeZone | | ### setDefaultTemplate(String value) {#setDefaultTemplate-java.lang.String} ``` public void setDefaultTemplate(String value) ``` Sets path to default template (including filename). Default value for this property is **empty string**. **Remarks:** If specified, this path is used to load template when [Document.getAutomaticallyUpdateStyles()](../../com.aspose.words/document/\#getAutomaticallyUpdateStyles) / [Document.setAutomaticallyUpdateStyles(boolean)](../../com.aspose.words/document/\#setAutomaticallyUpdateStyles-boolean) is true , but [Document.getAttachedTemplate()](../../com.aspose.words/document/\#getAttachedTemplate) / [Document.setAttachedTemplate(java.lang.String)](../../com.aspose.words/document/\#setAttachedTemplate-java.lang.String) is empty. **Examples:** Shows how to set a default template for documents that do not have attached templates. ``` Document doc = new Document(); // Enable automatic style updating, but do not attach a template document. doc.setAutomaticallyUpdateStyles(true); Assert.assertEquals("", doc.getAttachedTemplate()); // Since there is no template document, the document had nowhere to track style changes. // Use a SaveOptions object to automatically set a template // if a document that we are saving does not have one. SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx"); options.setDefaultTemplate(getMyDir() + "Business brochure.dotx"); doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | Path to default template (including filename). | ### setDigitalSignatureDetails(DigitalSignatureDetails value) {#setDigitalSignatureDetails-com.aspose.words.DigitalSignatureDetails} ``` public void setDigitalSignatureDetails(DigitalSignatureDetails value) ``` Sets [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) object used to sign a document. **Examples:** Shows how to sign OOXML document. ``` Document doc = new Document(getMyDir() + "Document.docx"); CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw"); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); SignOptions signOptions = new SignOptions(); signOptions.setComments("Some comments"); signOptions.setSignTime(new Date()); saveOptions.setDigitalSignatureDetails(new DigitalSignatureDetails( certificateHolder, signOptions)); doc.save(getArtifactsDir() + "OoxmlSaveOptions.DigitalSignature.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) | [DigitalSignatureDetails](../../com.aspose.words/digitalsignaturedetails/) object used to sign a document. | ### setDml3DEffectsRenderingMode(int value) {#setDml3DEffectsRenderingMode-int} ``` public void setDml3DEffectsRenderingMode(int value) ``` Sets a value determining how 3D effects are rendered. **Remarks:** The default value is [Dml3DEffectsRenderingMode.BASIC](../../com.aspose.words/dml3deffectsrenderingmode/\#BASIC). **Examples:** Shows how 3D effects are rendered. ``` Document doc = new Document(getMyDir() + "DrawingML shape 3D effects.docx"); RenderCallback warningCallback = new RenderCallback(); doc.setWarningCallback(warningCallback); PdfSaveOptions saveOptions = new PdfSaveOptions(); saveOptions.setDml3DEffectsRenderingMode(Dml3DEffectsRenderingMode.ADVANCED); doc.save(getArtifactsDir() + "PdfSaveOptions.Dml3DEffectsRenderingModeTest.pdf", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | A value determining how 3D effects are rendered. The value must be one of [Dml3DEffectsRenderingMode](../../com.aspose.words/dml3deffectsrenderingmode/) constants. | ### setDmlEffectsRenderingMode(int value) {#setDmlEffectsRenderingMode-int} ``` public void setDmlEffectsRenderingMode(int value) ``` Sets a value determining how DrawingML effects are rendered. **Remarks:** The default value is [DmlEffectsRenderingMode.SIMPLIFIED](../../com.aspose.words/dmleffectsrenderingmode/\#SIMPLIFIED). This property is used when the document is exported to fixed page formats. **Examples:** Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF. ``` Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified" // to render a simplified version of DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to // render DrawingML effects with more accuracy and also with more processing cost. options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | A value determining how DrawingML effects are rendered. The value must be one of [DmlEffectsRenderingMode](../../com.aspose.words/dmleffectsrenderingmode/) constants. | ### setDmlRenderingMode(int value) {#setDmlRenderingMode-int} ``` public void setDmlRenderingMode(int value) ``` Sets a value determining how DrawingML shapes are rendered. **Remarks:** The default value is [DmlRenderingMode.FALLBACK](../../com.aspose.words/dmlrenderingmode/\#FALLBACK). This property is used when the document is exported to fixed page formats. **Examples:** Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF. ``` Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified" // to render a simplified version of DrawingML effects. // Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to // render DrawingML effects with more accuracy and also with more processing cost. options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options); ``` Shows how to render fallback shapes when saving to PDF. ``` Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback" // to substitute DML shapes with their fallback shapes. // Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML" // to render the DML shapes themselves. options.setDmlRenderingMode(dmlRenderingMode); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | A value determining how DrawingML shapes are rendered. The value must be one of [DmlRenderingMode](../../com.aspose.words/dmlrenderingmode/) constants. | ### setExportGeneratorName(boolean value) {#setExportGeneratorName-boolean} ``` public void setExportGeneratorName(boolean value) ``` When true , causes the name and version of Aspose.Words to be embedded into produced files. Default value is true . **Examples:** Shows how to disable adding name and version of Aspose.Words into produced files. ``` Document doc = new Document(); // Use https://docs.aspose.com/words/net/generator-or-producer-name-included-in-output-documents/ to know how to check the result. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setExportGeneratorName(false); } doc.save(getArtifactsDir() + "OoxmlSaveOptions.ExportGeneratorName.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setImlRenderingMode(int value) {#setImlRenderingMode-int} ``` public void setImlRenderingMode(int value) ``` Sets a value determining how ink (InkML) objects are rendered. **Remarks:** The default value is [ImlRenderingMode.INK\_ML](../../com.aspose.words/imlrenderingmode/\#INK-ML). This property is used when the document is exported to fixed page formats. **Examples:** Shows how to render Ink object. ``` Document doc = new Document(getMyDir() + "Ink object.docx"); // Set 'ImlRenderingMode.InkML' ignores fall-back shape of ink (InkML) object and renders InkML itself. // If the rendering result is unsatisfactory, // please use 'ImlRenderingMode.Fallback' to get a result similar to previous versions. ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG); { saveOptions.setImlRenderingMode(ImlRenderingMode.INK_ML); } doc.save(getArtifactsDir() + "ImageSaveOptions.RenderInkObject.jpeg", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | A value determining how ink (InkML) objects are rendered. The value must be one of [ImlRenderingMode](../../com.aspose.words/imlrenderingmode/) constants. | ### setKeepLegacyControlChars(boolean value) {#setKeepLegacyControlChars-boolean} ``` public void setKeepLegacyControlChars(boolean value) ``` Keeps original representation of legacy control characters. **Examples:** Shows how to support legacy control characters when converting to .docx. ``` Document doc = new Document(getMyDir() + "Legacy control character.doc"); // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object // and then pass it to the document's saving method to modify how we save the document. // Set the "KeepLegacyControlChars" property to "true" to preserve // the "ShortDateTime" legacy character while saving. // Set the "KeepLegacyControlChars" property to "false" to remove // the "ShortDateTime" legacy character from the output document. OoxmlSaveOptions so = new OoxmlSaveOptions(SaveFormat.DOCX); so.setKeepLegacyControlChars(keepLegacyControlChars); doc.save(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx", so); doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx"); if (keepLegacyControlChars) Assert.assertEquals("date \\@ \"M/d/yyyy\"\f", doc.getFirstSection().getBody().getText()); else Assert.assertEquals("\f", doc.getFirstSection().getBody().getText()); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setMemoryOptimization(boolean value) {#setMemoryOptimization-boolean} ``` public void setMemoryOptimization(boolean value) ``` Sets value determining if memory optimization should be performed before saving the document. Default value for this property is false . **Remarks:** Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time. **Examples:** Shows an option to optimize memory consumption when rendering large documents to PDF. ``` Document doc = new Document(getMyDir() + "Rendering.docx"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); // Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations // at the cost of increasing the duration of the operation. // Set the "MemoryOptimization" property to "false" to save the document as a PDF normally. saveOptions.setMemoryOptimization(memoryOptimization); doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | Value determining if memory optimization should be performed before saving the document. | ### setPassword(String value) {#setPassword-java.lang.String} ``` public void setPassword(String value) ``` Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm. **Remarks:** In order to save document without encryption this property should be null or empty string. **Examples:** Shows how to create a password encrypted Office Open XML document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello world!"); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setPassword("MyPassword"); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", saveOptions); // We will not be able to open this document with Microsoft Word or // Aspose.Words without providing the correct password. Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx")); // Open the encrypted document by passing the correct password in a LoadOptions object. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", new LoadOptions("MyPassword")); Assert.assertEquals("Hello world!", doc.getText().trim()); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The corresponding java.lang.String value. | ### setPrettyFormat(boolean value) {#setPrettyFormat-boolean} ``` public void setPrettyFormat(boolean value) ``` When true , pretty formats output where applicable. Default value is false . **Remarks:** Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging. **Examples:** Shows how to enhance the readability of the raw code of a saved .html document. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello world!"); HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML); { htmlOptions.setPrettyFormat(usePrettyFormat); } doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions); // Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters. String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8); if (usePrettyFormat) Assert.assertEquals( "\r\n" + "\t\r\n" + "\t\t\r\n" + "\t\t\r\n" + MessageFormat.format("\t\t\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) + "\t\t\r\n" + "\t\t\r\n" + "\t\r\n" + "\t\r\n" + "\t\t \r\n" + "\t\t\t \r\n" + "\t\t\t\tHello world!\r\n" + "\t\t\t\r\n" + "\t\t\t \r\n" + "\t\t\t\t \r\n" + "\t\t\t\r\n" + "\t\t\r\n" + "\t\r\n", html); else Assert.assertEquals( "" + "" + MessageFormat.format("", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) + "" + " Hello world!" + "  ", html); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setProgressCallback(IDocumentSavingCallback value) {#setProgressCallback-com.aspose.words.IDocumentSavingCallback} ``` public void setProgressCallback(IDocumentSavingCallback value) ``` Called during saving a document and accepts data about saving progress. **Remarks:** Progress is reported when saving to [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX), [SaveFormat.FLAT\_OPC](../../com.aspose.words/saveformat/\#FLAT-OPC), [SaveFormat.DOCM](../../com.aspose.words/saveformat/\#DOCM), [SaveFormat.DOTM](../../com.aspose.words/saveformat/\#DOTM), [SaveFormat.DOTX](../../com.aspose.words/saveformat/\#DOTX), [SaveFormat.DOC](../../com.aspose.words/saveformat/\#DOC), [SaveFormat.DOT](../../com.aspose.words/saveformat/\#DOT), [SaveFormat.HTML](../../com.aspose.words/saveformat/\#HTML), [SaveFormat.MHTML](../../com.aspose.words/saveformat/\#MHTML), [SaveFormat.EPUB](../../com.aspose.words/saveformat/\#EPUB), [SaveFormat.XAML\_FLOW](../../com.aspose.words/saveformat/\#XAML-FLOW), or [SaveFormat.XAML\_FLOW\_PACK](../../com.aspose.words/saveformat/\#XAML-FLOW-PACK). **Examples:** Shows how to manage a document while saving to html. ``` public void progressCallback(int saveFormat, String ext) throws Exception { Document doc = new Document(getMyDir() + "Big document.docx"); // Following formats are supported: Html, Mhtml, Epub. HtmlSaveOptions saveOptions = new HtmlSaveOptions(saveFormat); { saveOptions.setProgressCallback(new SavingProgressCallback()); } try { doc.save(getArtifactsDir() + MessageFormat.format("HtmlSaveOptions.ProgressCallback.{0}", ext), saveOptions); } catch (IllegalStateException exception) { Assert.assertTrue(exception.getMessage().contains("EstimatedProgress")); } } public static Object[][] progressCallbackDataProvider() throws Exception { return new Object[][] { {SaveFormat.HTML, "html"}, {SaveFormat.MHTML, "mhtml"}, {SaveFormat.EPUB, "epub"}, }; } /// /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds. /// public static class SavingProgressCallback implements IDocumentSavingCallback { /// /// Ctr. /// public SavingProgressCallback() { mSavingStartedAt = new Date(); } /// /// Callback method which called during document saving. /// /// Saving arguments. public void notify(DocumentSavingArgs args) { Date canceledAt = new Date(); long diff = canceledAt.getTime() - mSavingStartedAt.getTime(); long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff); if (ellapsedSeconds > MAX_DURATION) throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt)); } /// /// Date and time when document saving is started. /// private Date mSavingStartedAt; /// /// Maximum allowed duration in sec. /// private static final double MAX_DURATION = 0.01d; } ``` Shows how to manage a document while saving to docx. ``` public void progressCallback(int saveFormat, String ext) throws Exception { Document doc = new Document(getMyDir() + "Big document.docx"); // Following formats are supported: Docx, FlatOpc, Docm, Dotm, Dotx. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(saveFormat); { saveOptions.setProgressCallback(new SavingProgressCallback()); } try { doc.save(getArtifactsDir() + MessageFormat.format("OoxmlSaveOptions.ProgressCallback.{0}", ext), saveOptions); } catch (IllegalStateException exception) { Assert.assertTrue(exception.getMessage().contains("EstimatedProgress")); } } public static Object[][] progressCallbackDataProvider() throws Exception { return new Object[][] { {SaveFormat.DOCX, "docx"}, {SaveFormat.DOCM, "docm"}, {SaveFormat.DOTM, "dotm"}, {SaveFormat.DOTX, "dotx"}, {SaveFormat.FLAT_OPC, "flatopc"}, }; } /// /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds. /// public static class SavingProgressCallback implements IDocumentSavingCallback { /// /// Ctr. /// public SavingProgressCallback() { mSavingStartedAt = new Date(); } /// /// Callback method which called during document saving. /// /// Saving arguments. public void notify(DocumentSavingArgs args) { Date canceledAt = new Date(); long diff = canceledAt.getTime() - mSavingStartedAt.getTime(); long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff); if (ellapsedSeconds > MAX_DURATION) throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt)); } /// /// Date and time when document saving is started. /// private Date mSavingStartedAt; /// /// Maximum allowed duration in sec. /// private static final double MAX_DURATION = 0.01d; } ``` Shows how to manage a document while saving to xamlflow. ``` public void progressCallback(int saveFormat, String ext) throws Exception { Document doc = new Document(getMyDir() + "Big document.docx"); // Following formats are supported: XamlFlow, XamlFlowPack. XamlFlowSaveOptions saveOptions = new XamlFlowSaveOptions(saveFormat); { saveOptions.setProgressCallback(new SavingProgressCallback()); } try { doc.save(getArtifactsDir() + MessageFormat.format("XamlFlowSaveOptions.ProgressCallback.{0}", ext), saveOptions); } catch (IllegalStateException exception) { Assert.assertTrue(exception.getMessage().contains("EstimatedProgress")); } } public static Object[][] progressCallbackDataProvider() throws Exception { return new Object[][] { {SaveFormat.XAML_FLOW, "xamlflow"}, {SaveFormat.XAML_FLOW_PACK, "xamlflowpack"}, }; } /// /// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds. /// public static class SavingProgressCallback implements IDocumentSavingCallback { /// /// Ctr. /// public SavingProgressCallback() { mSavingStartedAt = new Date(); } /// /// Callback method which called during document saving. /// /// Saving arguments. public void notify(DocumentSavingArgs args) { Date canceledAt = new Date(); long diff = canceledAt.getTime() - mSavingStartedAt.getTime(); long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff); if (ellapsedSeconds > MAX_DURATION) throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt)); } /// /// Date and time when document saving is started. /// private Date mSavingStartedAt; /// /// Maximum allowed duration in sec. /// private static final double MAX_DURATION = 0.01d; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | [IDocumentSavingCallback](../../com.aspose.words/idocumentsavingcallback/) | The corresponding [IDocumentSavingCallback](../../com.aspose.words/idocumentsavingcallback/) value. | ### setSaveFormat(int value) {#setSaveFormat-int} ``` public void setSaveFormat(int value) ``` Specifies the format in which the document will be saved if this save options object is used. Can be [SaveFormat.DOCX](../../com.aspose.words/saveformat/\#DOCX), [SaveFormat.DOCM](../../com.aspose.words/saveformat/\#DOCM), [SaveFormat.DOTX](../../com.aspose.words/saveformat/\#DOTX), [SaveFormat.DOTM](../../com.aspose.words/saveformat/\#DOTM) or [SaveFormat.FLAT\_OPC](../../com.aspose.words/saveformat/\#FLAT-OPC). **Examples:** Shows how to set an OOXML compliance specification for a saved document to adhere to. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // If we configure compatibility options to comply with Microsoft Word 2003, // inserting an image will define its shape using VML. doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // 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. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // Our saved document defines the shape using DML to adhere to the "ISO/IEC 29500:2008" OOXML standard. doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | The corresponding int value. The value must be one of [SaveFormat](../../com.aspose.words/saveformat/) constants. | ### setTempFolder(String value) {#setTempFolder-java.lang.String} ``` public void setTempFolder(String value) ``` Specifies 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. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The corresponding java.lang.String value. | ### setUpdateAmbiguousTextFont(boolean value) {#setUpdateAmbiguousTextFont-boolean} ``` public void setUpdateAmbiguousTextFont(boolean value) ``` Determines whether the font attributes will be changed according to the character code being used. **Examples:** Shows how to update the font to match the character code being used. ``` Document doc = new Document(getMyDir() + "Special symbol.docx"); Run run = doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0); System.out.println(run.getText()); // \u0e3f System.out.println(run.getFont().getName()); // Arial OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateAmbiguousTextFont(true); doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdateAmbiguousTextFont.docx", saveOptions); doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.UpdateAmbiguousTextFont.docx"); run = doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0); System.out.println(run.getText()); // \u0e3f System.out.println(run.getFont().getName()); // Angsana New ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setUpdateCreatedTimeProperty(boolean value) {#setUpdateCreatedTimeProperty-boolean} ``` public void setUpdateCreatedTimeProperty(boolean value) ``` Sets a value determining whether the [BuiltInDocumentProperties.getCreatedTime()](../../com.aspose.words/builtindocumentproperties/\#getCreatedTime) / [BuiltInDocumentProperties.setCreatedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setCreatedTime-java.util.Date) property is updated before saving. Default value is false ; **Examples:** Shows how to update a document's "CreatedTime" property when saving. ``` Document doc = new Document(); Calendar calendar = Calendar.getInstance(); calendar.set(2019, 11, 20); doc.getBuiltInDocumentProperties().setCreatedTime(calendar.getTime()); // This flag determines whether the created time, which is a built-in property, is updated. // If so, then the date of the document's most recent save operation // with this SaveOptions object passed as a parameter is used as the created time. DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setUpdateCreatedTimeProperty(isUpdateCreatedTimeProperty); doc.save(getArtifactsDir() + "DocSaveOptions.UpdateCreatedTimeProperty.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining whether the [BuiltInDocumentProperties.getCreatedTime()](../../com.aspose.words/builtindocumentproperties/\#getCreatedTime) / [BuiltInDocumentProperties.setCreatedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setCreatedTime-java.util.Date) property is updated before saving. | ### setUpdateFields(boolean value) {#setUpdateFields-boolean} ``` public void setUpdateFields(boolean value) ``` 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 . **Remarks:** Allows to specify whether to mimic or not MS Word behavior. **Examples:** Shows how to update all the fields in a document immediately before saving it to PDF. ``` Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time. // We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()" // each time we need them to display accurate values. builder.write("Page "); builder.insertField("PAGE", ""); builder.write(" of "); builder.insertField("NUMPAGES", ""); builder.insertBreak(BreakType.PAGE_BREAK); builder.writeln("Hello World!"); // Create a "PdfSaveOptions" object that we can pass to the document's "Save" method // to modify how that method converts the document to .PDF. PdfSaveOptions options = new PdfSaveOptions(); // Set the "UpdateFields" property to "false" to not update all the fields in a document right before a save operation. // This is the preferable option if we know that all our fields will be up to date before saving. // Set the "UpdateFields" property to "true" to iterate through all the document // fields and update them before we save it as a PDF. This will make sure that all the fields will display // the most accurate values in the PDF. options.setUpdateFields(updateFields); // We can clone PdfSaveOptions objects. Assert.assertNotSame(options, options.deepClone()); doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining if fields of certain types should be updated before saving the document to a fixed page format. | ### setUpdateLastPrintedProperty(boolean value) {#setUpdateLastPrintedProperty-boolean} ``` public void setUpdateLastPrintedProperty(boolean value) ``` Sets a value determining whether the [BuiltInDocumentProperties.getLastPrinted()](../../com.aspose.words/builtindocumentproperties/\#getLastPrinted) / [BuiltInDocumentProperties.setLastPrinted(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastPrinted-java.util.Date) property is updated before saving. **Examples:** Shows how to update a document's "Last printed" property when saving. ``` Document doc = new Document(); Calendar calendar = Calendar.getInstance(); calendar.set(2019, 11, 20); doc.getBuiltInDocumentProperties().setLastPrinted(calendar.getTime()); // This flag determines whether the last printed date, which is a built-in property, is updated. // If so, then the date of the document's most recent save operation // with this SaveOptions object passed as a parameter is used as the print date. DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty); // In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed. // It can also be displayed in the document's body by using a PRINTDATE field. doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining whether the [BuiltInDocumentProperties.getLastPrinted()](../../com.aspose.words/builtindocumentproperties/\#getLastPrinted) / [BuiltInDocumentProperties.setLastPrinted(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastPrinted-java.util.Date) property is updated before saving. | ### setUpdateLastSavedTimeProperty(boolean value) {#setUpdateLastSavedTimeProperty-boolean} ``` public void setUpdateLastSavedTimeProperty(boolean value) ``` Sets a value determining whether the [BuiltInDocumentProperties.getLastSavedTime()](../../com.aspose.words/builtindocumentproperties/\#getLastSavedTime) / [BuiltInDocumentProperties.setLastSavedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastSavedTime-java.util.Date) property is updated before saving. **Examples:** Shows how to determine whether to preserve the document's "Last saved time" property when saving. ``` Document doc = new Document(getMyDir() + "Document.docx"); // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object // and then pass it to the document's saving method to modify how we save the document. // Set the "UpdateLastSavedTimeProperty" property to "true" to // set the output document's "Last saved time" built-in property to the current date/time. // Set the "UpdateLastSavedTimeProperty" property to "false" to // preserve the original value of the input document's "Last saved time" built-in property. OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty); doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining whether the [BuiltInDocumentProperties.getLastSavedTime()](../../com.aspose.words/builtindocumentproperties/\#getLastSavedTime) / [BuiltInDocumentProperties.setLastSavedTime(java.util.Date)](../../com.aspose.words/builtindocumentproperties/\#setLastSavedTime-java.util.Date) property is updated before saving. | ### setUpdateOleControlImages(boolean value) {#setUpdateOleControlImages-boolean} ``` public void setUpdateOleControlImages(boolean value) ``` Sets a value determining whether OLE controls presentation image will be updated. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining whether OLE controls presentation image will be updated. | ### setUseAntiAliasing(boolean value) {#setUseAntiAliasing-boolean} ``` public void setUseAntiAliasing(boolean value) ``` Sets a value determining whether or not to use anti-aliasing for rendering. **Remarks:** The default value is false . When this value is set to true anti-aliasing is used for rendering. This property is used when the document is exported to the following formats: [SaveFormat.TIFF](../../com.aspose.words/saveformat/\#TIFF), [SaveFormat.PNG](../../com.aspose.words/saveformat/\#PNG), [SaveFormat.BMP](../../com.aspose.words/saveformat/\#BMP), [SaveFormat.JPEG](../../com.aspose.words/saveformat/\#JPEG), [SaveFormat.EMF](../../com.aspose.words/saveformat/\#EMF). When the document is exported to the [SaveFormat.HTML](../../com.aspose.words/saveformat/\#HTML), [SaveFormat.MHTML](../../com.aspose.words/saveformat/\#MHTML), [SaveFormat.EPUB](../../com.aspose.words/saveformat/\#EPUB), [SaveFormat.AZW\_3](../../com.aspose.words/saveformat/\#AZW-3) or [SaveFormat.MOBI](../../com.aspose.words/saveformat/\#MOBI) formats this option is used for raster images. **Examples:** Shows how to improve the quality of a rendered document with SaveOptions. ``` Document doc = new Document(getMyDir() + "Rendering.docx"); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining whether or not to use anti-aliasing for rendering. | ### setUseHighQualityRendering(boolean value) {#setUseHighQualityRendering-boolean} ``` public void setUseHighQualityRendering(boolean value) ``` Sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. **Remarks:** The default value is false . This property is used when the document is exported to image formats: [SaveFormat.TIFF](../../com.aspose.words/saveformat/\#TIFF), [SaveFormat.PNG](../../com.aspose.words/saveformat/\#PNG), [SaveFormat.BMP](../../com.aspose.words/saveformat/\#BMP), [SaveFormat.JPEG](../../com.aspose.words/saveformat/\#JPEG), [SaveFormat.EMF](../../com.aspose.words/saveformat/\#EMF). **Examples:** Shows how to improve the quality of a rendered document with SaveOptions. ``` Document doc = new Document(getMyDir() + "Rendering.docx"); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | A value determining whether or not to use high quality (i.e. | ### setZip64Mode(int value) {#setZip64Mode-int} ``` public void setZip64Mode(int value) ``` Specifies whether or not to use ZIP64 format extensions for the output document. The default value is [Zip64Mode.NEVER](../../com.aspose.words/zip64mode/\#NEVER). **Examples:** Shows how to use ZIP64 format extensions. ``` Random random = new Random(); DocumentBuilder builder = new DocumentBuilder(); for (int i = 0; i < 10000; i++) { BufferedImage bmp = new BufferedImage(5, 5, BufferedImage.TYPE_INT_ARGB); Graphics2D g = bmp.createGraphics(); g.setColor(new Color(random.nextInt(254), random.nextInt(254), random.nextInt(254))); g.drawImage(bmp, 0, 0, null); g.dispose(); builder.insertImage(bmp); } OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setZip64Mode(Zip64Mode.ALWAYS); builder.getDocument().save(getArtifactsDir() + "OoxmlSaveOptions.Zip64ModeOption.docx", saveOptions); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | The corresponding int value. The value must be one of [Zip64Mode](../../com.aspose.words/zip64mode/) constants. |