com.aspose.words

Class DocSaveOptions

  • java.lang.Object
public class DocSaveOptions 
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.DOC or SaveFormat.DOT format.

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

Example:

Shows how to set save options for classic Microsoft Word document versions.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");

// DocSaveOptions only applies to Doc and Dot save formats
DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);

// Set a password with which the document will be encrypted, and which will be required to open it
options.setPassword("MyPassword");

// If the document contains a routing slip, we can preserve it while saving by setting this flag to true
options.setSaveRoutingSlip(true);

doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);

Constructor Summary
DocSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC format.
DocSaveOptions(intsaveFormat)
Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC or SaveFormat.DOT format.
 
Property Getters/Setters Summary
booleangetAlwaysCompressMetafiles()
void
           When false, small metafiles are not compressed for performance reason. Default value is true, all metafiles are compressed regardless of its size.
intgetColorMode()
void
setColorMode(intvalue)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
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.
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.
java.lang.StringgetPassword()
void
setPassword(java.lang.Stringvalue)
           Gets/sets a password to encrypt document using RC4 encryption method.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.DOC or SaveFormat.DOT. The value of the property is SaveFormat integer constant.
booleangetSavePictureBullet()
void
setSavePictureBullet(booleanvalue)
           When false, PictureBullet data is not saved to output document. Default value is true.
booleangetSaveRoutingSlip()
void
setSaveRoutingSlip(booleanvalue)
           When false, RoutingSlip data is not saved to output document. Default value is true.
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.
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.
 

    • Constructor Detail

      • DocSaveOptions

        public DocSaveOptions()
        Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC format.

        Example:

        Shows how to set save options for classic Microsoft Word document versions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.write("Hello world!");
        
        // DocSaveOptions only applies to Doc and Dot save formats
        DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
        
        // Set a password with which the document will be encrypted, and which will be required to open it
        options.setPassword("MyPassword");
        
        // If the document contains a routing slip, we can preserve it while saving by setting this flag to true
        options.setSaveRoutingSlip(true);
        
        doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
      • DocSaveOptions

        public DocSaveOptions(int saveFormat)
        Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC or SaveFormat.DOT format.
        Parameters:
        saveFormat - A SaveFormat value. Can be SaveFormat.DOC or SaveFormat.DOT.

        Example:

        Shows how to set save options for classic Microsoft Word document versions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.write("Hello world!");
        
        // DocSaveOptions only applies to Doc and Dot save formats
        DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
        
        // Set a password with which the document will be encrypted, and which will be required to open it
        options.setPassword("MyPassword");
        
        // If the document contains a routing slip, we can preserve it while saving by setting this flag to true
        options.setSaveRoutingSlip(true);
        
        doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
    • Property Getters/Setters Detail

      • getAlwaysCompressMetafiles/setAlwaysCompressMetafiles

        public boolean getAlwaysCompressMetafiles() / public void setAlwaysCompressMetafiles(boolean value)
        
        When false, small metafiles are not compressed for performance reason. Default value is true, all metafiles are compressed regardless of its size.

        Example:

        Shows how to change metafiles compression in a document while saving.
        // The document has a mathematical formula
        Document doc = new Document(getMyDir() + "Document.AlwaysCompressMetafiles.doc");
        
        // Large metafiles are always compressed when exporting a document in Aspose.Words, but small metafiles are not
        // compressed for performance reason. Some other document editors, such as LibreOffice, cannot read uncompressed
        // metafiles. The following option 'AlwaysCompressMetafiles' was introduced to choose appropriate behavior
        DocSaveOptions saveOptions = new DocSaveOptions();
        // False - small metafiles are not compressed for performance reason
        // True - all metafiles are compressed regardless of its size
        saveOptions.setAlwaysCompressMetafiles(isAlwaysCompressMetafiles);
        
        doc.save(getArtifactsDir() + "Document.AlwaysCompressMetafiles.doc", saveOptions);
      • getColorMode/setColorMode

        public int getColorMode() / public void setColorMode(int value)
        
        Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL.

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

        Example:

        Shows how change image color with save options property
        // Open document with color image
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Set grayscale mode for document
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE);
        
        // Assert that color image in document was grey
        doc.save(getArtifactsDir() + "ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
      • 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.AutomaticallyUpdateSyles is true, but Document.AttachedTemplate is empty.

        Example:

        Shows how to set a default .docx document template.
        Document doc = new Document();
        
        // If we set this flag to true while not having a template attached to the document,
        // there will be no effect because there is no template document to draw style changes from
        doc.setAutomaticallyUpdateSyles(true);
        Assert.assertTrue(doc.getAttachedTemplate().isEmpty());
        
        // We can set a default template document filename in a SaveOptions object to make it apply to
        // all documents we save with it that have no AttachedTemplate value
        SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
        options.setDefaultTemplate(getMyDir() + "Document.BusinessBrochureTemplate.dotx");
        
        doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
      • 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 export custom properties while saving to .pdf.
        Document doc = new Document();
        
        // Add a custom document property that doesn't use the name of some built in properties
        doc.getCustomDocumentProperties().add("Company", "My value");
        
        // Configure the PdfSaveOptions like this will display the properties
        // in the "Document Properties" menu of Adobe Acrobat Pro
        PdfSaveOptions options = new PdfSaveOptions();
        options.setCustomPropertiesExport(PdfCustomPropertiesExport.STANDARD);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.CustomPropertiesExport.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 define rendering for DML shapes
        Document doc = DocumentHelper.createDocumentFillWithDummyText();
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML);
        
        doc.save(getArtifactsDir() + "DrawingMl.pdf", pdfSaveOptions);

        Example:

        Shows how to configure DrawingML rendering quality with PdfSaveOptions.
        Document doc = new Document(getMyDir() + "DrawingMLEffects.docx");
        
        // Creating a new PdfSaveOptions object and setting its DmlEffectsRenderingMode to "None" will
        // strip the shapes of all their shading effects in the output pdf
        PdfSaveOptions options = new PdfSaveOptions();
        options.setDmlEffectsRenderingMode(DmlEffectsRenderingMode.NONE);
        
        doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.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() + "SaveOptions.MemoryOptimization.doc");
        
        // When set to true it will improve document memory footprint but will add extra time to processing. 
        // This optimization is only applied during save operation.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        saveOptions.setMemoryOptimization(true);
        
        doc.save(getArtifactsDir() + "SaveOptions.MemoryOptimization.pdf", saveOptions);
      • getPassword/setPassword

        public java.lang.String getPassword() / public void setPassword(java.lang.String value)
        
        Gets/sets a password to encrypt document using RC4 encryption method.

        In order to save document without encryption this property should be null or empty string.

        Example:

        Shows how to set save options for classic Microsoft Word document versions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.write("Hello world!");
        
        // DocSaveOptions only applies to Doc and Dot save formats
        DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
        
        // Set a password with which the document will be encrypted, and which will be required to open it
        options.setPassword("MyPassword");
        
        // If the document contains a routing slip, we can preserve it while saving by setting this flag to true
        options.setSaveRoutingSlip(true);
        
        doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
      • 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.

        Example:

        Shows how to pass an option to export HTML tags in a well spaced, human readable format.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
        // Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read.
        // If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation.
        htmlOptions.setPrettyFormat(true);
        
        doc.save(getArtifactsDir() + "Document.PrettyFormat.html", htmlOptions);
      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / 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.DOC or SaveFormat.DOT. The value of the property is SaveFormat integer constant.

        Example:

        Shows how to set save options for classic Microsoft Word document versions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.write("Hello world!");
        
        // DocSaveOptions only applies to Doc and Dot save formats
        DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
        
        // Set a password with which the document will be encrypted, and which will be required to open it
        options.setPassword("MyPassword");
        
        // If the document contains a routing slip, we can preserve it while saving by setting this flag to true
        options.setSaveRoutingSlip(true);
        
        doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
      • getSavePictureBullet/setSavePictureBullet

        public boolean getSavePictureBullet() / public void setSavePictureBullet(boolean value)
        
        When false, PictureBullet data is not saved to output document. Default value is true.

        This option is provided for Word 97, which cannot work correctly with PictureBullet data. To remove PictureBullet data, set the option to "false".

      • getSaveRoutingSlip/setSaveRoutingSlip

        public boolean getSaveRoutingSlip() / public void setSaveRoutingSlip(boolean value)
        
        When false, RoutingSlip data is not saved to output document. Default value is true.

        Example:

        Shows how to set save options for classic Microsoft Word document versions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.write("Hello world!");
        
        // DocSaveOptions only applies to Doc and Dot save formats
        DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
        
        // Set a password with which the document will be encrypted, and which will be required to open it
        options.setPassword("MyPassword");
        
        // If the document contains a routing slip, we can preserve it while saving by setting this flag to true
        options.setSaveRoutingSlip(true);
        
        doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
      • 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 save a document using temporary files.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // We can use a SaveOptions object to set the saving method of a document from a MemoryStream to temporary files
        // While saving, the files will briefly pop up in the folder we set as the TempFolder attribute below
        // Doing this will free up space in the memory that the stream would usually occupy
        DocSaveOptions options = new DocSaveOptions();
        options.setTempFolder(getArtifactsDir() + "TempFiles");
        
        // Ensure that the directory exists and save
        new File(options.getTempFolder()).mkdir();
        
        doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
      • 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 behaviour.

        Example:

        Shows how to update fields before saving into a PDF document.
        Document doc = DocumentHelper.createDocumentFillWithDummyText();
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setUpdateFields(false);
        
        // PdfSaveOptions objects can be cloned
        Assert.assertNotSame(pdfSaveOptions, pdfSaveOptions.deepClone());
        
        doc.save(getArtifactsDir() + "UpdateFields_False.pdf", pdfSaveOptions);
      • 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.doc");
        
        //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(false);
        
        doc.save(getArtifactsDir() + "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:

        Improve the quality of a rendered document with SaveOptions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setSize(60.0);
        
        builder.writeln("Some text.");
        
        SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        Assert.assertEquals(options.getUseAntiAliasing(), false);
        
        doc.save(getArtifactsDir() + "Document.SaveOptionsDefault.jpg", options);
        
        options.setUseAntiAliasing(true);
        options.setUseHighQualityRendering(true);
        doc.save(getArtifactsDir() + "Document.SaveOptionsHighQuality.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:

        Improve the quality of a rendered document with SaveOptions.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setSize(60.0);
        
        builder.writeln("Some text.");
        
        SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
        Assert.assertEquals(options.getUseAntiAliasing(), false);
        
        doc.save(getArtifactsDir() + "Document.SaveOptionsDefault.jpg", options);
        
        options.setUseAntiAliasing(true);
        options.setUseHighQualityRendering(true);
        doc.save(getArtifactsDir() + "Document.SaveOptionsHighQuality.jpg", options);