com.aspose.words

Class SaveOptions

  • java.lang.Object
    • com.aspose.words.SaveOptions
This is an abstract base class for classes that allow the user to specify additional options when saving a document into a particular format.
An instance of the SaveOptions class or any derived class is passed to the stream Document.save(java.io.OutputStream,com.aspose.words.SaveOptions) or string Document.save(java.lang.String,com.aspose.words.SaveOptions) overloads for the user to define custom options when saving a document.

Example:

Shows how to specify saving options while converting a document to .epub.
Document doc = new Document(getMyDir() + "Rendering.docx");

// Specify encoding for a document that we will save with a SaveOptions object.
HtmlSaveOptions saveOptions = new HtmlSaveOptions();
saveOptions.setSaveFormat(SaveFormat.EPUB);
saveOptions.setEncoding(StandardCharsets.UTF_8);

// By default, an output .epub document will have all the contents in one HTML part.
// A split criteria allows us to segment the document into several HTML parts.
// We will set the criteria to split the document at heading paragraphs.
// This is useful for readers which cannot read HTML files greater than a certain size.
saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);

// Specify that we want to export document properties.
saveOptions.setExportDocumentProperties(true);

doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);

Property Getters/Setters Summary
java.lang.StringgetDefaultTemplate()
void
setDefaultTemplate(java.lang.Stringvalue)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
intgetDml3DEffectsRenderingMode()
void
           Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.
intgetDmlEffectsRenderingMode()
void
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
void
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
booleangetMemoryOptimization()
void
setMemoryOptimization(booleanvalue)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
abstract intgetSaveFormat()
abstractvoid
setSaveFormat(intvalue)
           Specifies the format in which the document will be saved if this save options object is used. The value of the property is SaveFormat integer constant.
java.lang.StringgetTempFolder()
void
setTempFolder(java.lang.Stringvalue)
           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.
booleangetUpdateFields()
void
setUpdateFields(booleanvalue)
           Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
booleangetUpdateLastPrintedProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.
booleangetUpdateLastSavedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
void
setUpdateSdtContent(booleanvalue)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
void
setUseAntiAliasing(booleanvalue)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()
void
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
 
Method Summary
static SaveOptionscreateSaveOptions(int saveFormat)
Creates a save options object of a class suitable for the specified save format.
static SaveOptionscreateSaveOptions(java.lang.String fileName)
Creates a save options object of a class suitable for the file extension specified in the given file name.
 

    • Property Getters/Setters Detail

      • getDefaultTemplate/setDefaultTemplate

        public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
        
        Gets or sets path to default template (including filename). Default value for this property is empty string. If specified, this path is used to load template when Document.AutomaticallyUpdateStyles is true, but Document.AttachedTemplate is empty.

        Example:

        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);
      • getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode

        public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value)
        
        Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. The default value is Dml3DEffectsRenderingMode.BASIC.
      • getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

        public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how to configure DrawingML rendering quality with PdfSaveOptions.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        PdfSaveOptions options = new PdfSaveOptions();
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • getDmlRenderingMode/setDmlRenderingMode

        public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how to render fallback shapes when saving to Pdf.
        Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
        
        PdfSaveOptions options = new PdfSaveOptions();
        options.setDmlRenderingMode(dmlRenderingMode);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

        Example:

        Shows how to configure DrawingML rendering quality with PdfSaveOptions.
        Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
        
        PdfSaveOptions options = new PdfSaveOptions();
        options.setDmlEffectsRenderingMode(effectsRenderingMode);
        
        Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
      • getMemoryOptimization/setMemoryOptimization

        public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
        
        Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

        Example:

        Shows an option to optimize memory consumption when you work with large documents.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // When set to true it will improve document memory footprint but will add extra time to processing
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        saveOptions.setMemoryOptimization(true);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
      • getPrettyFormat/setPrettyFormat

        public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
        
        When true, pretty formats output where applicable. Default value is false.

        Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.

      • getSaveFormat/setSaveFormat

        public abstract int getSaveFormat() / public abstract void setSaveFormat(int value)
        
        Specifies the format in which the document will be saved if this save options object is used. The value of the property is SaveFormat integer constant.

        Example:

        Shows how to specify saving options while converting a document to .epub.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // Specify encoding for a document that we will save with a SaveOptions object.
        HtmlSaveOptions saveOptions = new HtmlSaveOptions();
        saveOptions.setSaveFormat(SaveFormat.EPUB);
        saveOptions.setEncoding(StandardCharsets.UTF_8);
        
        // By default, an output .epub document will have all the contents in one HTML part.
        // A split criteria allows us to segment the document into several HTML parts.
        // We will set the criteria to split the document at heading paragraphs.
        // This is useful for readers which cannot read HTML files greater than a certain size.
        saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);
        
        // Specify that we want to export document properties.
        saveOptions.setExportDocumentProperties(true);
        
        doc.save(getArtifactsDir() + "HtmlSaveOptions.Doc2EpubSaveOptions.epub", saveOptions);
      • getTempFolder/setTempFolder

        public java.lang.String getTempFolder() / public void setTempFolder(java.lang.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.

        When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

        If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

        The folder must exist and be writable, otherwise an exception will be thrown.

        Aspose.Words automatically deletes all temporary files when saving is complete.

        Example:

        Shows how to use the hard drive instead of memory when saving a document.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // When we save a document, various elements are temporarily stored in memory as the save operation is taking place.
        // We can use this option to use a temporary folder in the local file system instead,
        // which will reduce our application's memory overhead.
        DocSaveOptions options = new DocSaveOptions();
        options.setTempFolder(getArtifactsDir() + "TempFiles");
        
        // The specified temporary folder must exist in the local file system before the save operation.
        new File(options.getTempFolder()).mkdir();
        
        doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
        
        // The folder will persist with no residual contents from the load operation.
        Assert.assertEquals(new File(options.getTempFolder()).listFiles().length, 0);
      • getUpdateFields/setUpdateFields

        public boolean getUpdateFields() / public void setUpdateFields(boolean value)
        
        Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. Allows to specify whether to mimic or not MS Word behavior.

        Example:

        Shows how to update fields before saving into a PDF document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        // Insert two pages of text, including two fields that will need to be updated to display an accurate value
        builder.write("Page ");
        builder.insertField("PAGE", "");
        builder.write(" of ");
        builder.insertField("NUMPAGES", "");
        builder.insertBreak(BreakType.PAGE_BREAK);
        builder.writeln("Hello World!");
        
        PdfSaveOptions options = new PdfSaveOptions();
        options.setUpdateFields(doUpdateFields);
        
        // PdfSaveOptions objects can be cloned
        Assert.assertNotSame(options, options.deepClone());
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
      • getUpdateLastPrintedProperty/setUpdateLastPrintedProperty

        public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.

        Example:

        Shows how to update a document's "Last printed" property when saving.
        Document doc = new Document();
        
        // 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);
        
        // Open the saved document, then verify the value of the property.
        doc = new Document(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc");
        
        Assert.assertNotEquals(Calendar.getInstance().getTime(), doc.getBuiltInDocumentProperties().getLastPrinted());
      • getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

        public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

        Example:

        Shows how to update a document time property when you want to save it.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // Get last saved time
        Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime();
        
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setUpdateLastSavedTimeProperty(true);
        
        doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdatingLastSavedTimeDocument.docx", saveOptions);
      • getUpdateSdtContent/setUpdateSdtContent

        public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
        
        Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.

        Example:

        Shows how structured document tags can be updated while saving to .pdf.
        Document doc = new Document();
        
        // Insert two StructuredDocumentTags; a date and a drop down list
        StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.BLOCK);
        tag.setFullDate(new Date());
        
        doc.getFirstSection().getBody().appendChild(tag);
        
        tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
        tag.getListItems().add(new SdtListItem("Value 1"));
        tag.getListItems().add(new SdtListItem("Value 2"));
        tag.getListItems().add(new SdtListItem("Value 3"));
        tag.getListItems().setSelectedValue(tag.getListItems().get(1));
        
        doc.getFirstSection().getBody().appendChild(tag);
        
        // We've selected default values for both tags
        // We can save those values in the document without immediately updating the tags, leaving them in their default state
        // by using a SaveOptions object with this flag set
        PdfSaveOptions options = new PdfSaveOptions();
        options.setUpdateSdtContent(updateSdtContent);
        
        doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
      • getUseAntiAliasing/setUseAntiAliasing

        public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
        
        Gets or sets a value determining whether or not to use anti-aliasing for rendering.

        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, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.

        Example:

        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);
      • getUseHighQualityRendering/setUseHighQualityRendering

        public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
        
        Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

        This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.

        Example:

        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);
    • Method Detail

      • createSaveOptions

        public static SaveOptions createSaveOptions(int saveFormat)
        Creates a save options object of a class suitable for the specified save format.
        Parameters:
        saveFormat - A SaveFormat value. The save format for which to create a save options object.
        Returns:
        An object of a class that derives from SaveOptions.

        Example:

        Shows an option to optimize memory consumption when you work with large documents.
        Document doc = new Document(getMyDir() + "Rendering.docx");
        
        // When set to true it will improve document memory footprint but will add extra time to processing
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        saveOptions.setMemoryOptimization(true);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
      • createSaveOptions

        public static SaveOptions createSaveOptions(java.lang.String fileName)
                                                 throws java.lang.Exception
        Creates a save options object of a class suitable for the file extension specified in the given file name.
        Parameters:
        fileName - The extension of this file name determines the class of the save options object to create.
        Returns:
        An object of a class that derives from SaveOptions.

        Example:

        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);