com.aspose.words
Class SaveOptions

java.lang.Object
    extended by com.aspose.words.SaveOptions
Direct Known Subclasses:
DocSaveOptions, FixedPageSaveOptions, HtmlSaveOptions, OdtSaveOptions, OoxmlSaveOptions, RtfSaveOptions, TxtSaveOptionsBase, WordML2003SaveOptions, XamlFlowSaveOptions

public abstract class SaveOptions 
extends java.lang.Object

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 convert a document to EPUB with save options specified.
// Open an existing document from disk
Document doc = new Document(getMyDir() + "Rendering.docx");

// Create a new instance of HtmlSaveOptions. This object allows us to set options that control
// how the output document is saved
HtmlSaveOptions saveOptions = new HtmlSaveOptions();

// Specify the desired encoding
saveOptions.setEncoding(Charset.forName("UTF-8"));

// Specify at what elements to split the internal HTML at. This creates a new HTML within the EPUB
// which allows you to limit the size of each HTML part. This is useful for readers which cannot read
// HTML files greater than a certain size e.g 300kb
saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);

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

// Specify that we want to save in EPUB format
saveOptions.setSaveFormat(SaveFormat.EPUB);

// Export the document as an EPUB file
doc.save(getArtifactsDir() + "Document.Doc2EpubSaveOptions.epub", saveOptions);

Property Getters/Setters Summary
java.lang.StringgetDefaultTemplate()
voidsetDefaultTemplate(java.lang.String value)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
intgetDml3DEffectsRenderingMode()
voidsetDml3DEffectsRenderingMode(int value)
           Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.
intgetDmlEffectsRenderingMode()
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
voidsetDmlRenderingMode(int value)
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
booleangetMemoryOptimization()
voidsetMemoryOptimization(boolean value)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
booleangetPrettyFormat()
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
abstract intgetSaveFormat()
abstract voidsetSaveFormat(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.
java.lang.StringgetTempFolder()
voidsetTempFolder(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.
booleangetUpdateFields()
voidsetUpdateFields(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.
booleangetUpdateLastPrintedProperty()
voidsetUpdateLastPrintedProperty(boolean value)
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.
booleangetUpdateLastSavedTimeProperty()
voidsetUpdateLastSavedTimeProperty(boolean value)
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()
voidsetUseHighQualityRendering(boolean value)
           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 .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.setAutomaticallyUpdateStyles(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() + "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.

Example:

Shows how to pass an option to export HTML tags in a well spaced, human readable format.
Document doc = new Document(getMyDir() + "Document.docx");

// 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
HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
htmlOptions.setPrettyFormat(isPrettyFormat);

doc.save(getArtifactsDir() + "Document.SaveHtmlPrettyFormat.html", htmlOptions);

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 convert a document to EPUB with save options specified.
// Open an existing document from disk
Document doc = new Document(getMyDir() + "Rendering.docx");

// Create a new instance of HtmlSaveOptions. This object allows us to set options that control
// how the output document is saved
HtmlSaveOptions saveOptions = new HtmlSaveOptions();

// Specify the desired encoding
saveOptions.setEncoding(Charset.forName("UTF-8"));

// Specify at what elements to split the internal HTML at. This creates a new HTML within the EPUB
// which allows you to limit the size of each HTML part. This is useful for readers which cannot read
// HTML files greater than a certain size e.g 300kb
saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH);

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

// Specify that we want to save in EPUB format
saveOptions.setSaveFormat(SaveFormat.EPUB);

// Export the document as an EPUB file
doc.save(getArtifactsDir() + "Document.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 save a document using temporary files.
Document doc = new Document(getMyDir() + "Rendering.docx");

// 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 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 BuiltInDocumentProperties.LastPrinted property before saving.
Document doc = new Document();

// Aspose.Words update BuiltInDocumentProperties.LastPrinted property by default
DocSaveOptions saveOptions = new DocSaveOptions();
saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);

doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.docx", saveOptions);

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 .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.setAutomaticallyUpdateStyles(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() + "Business brochure.dotx");

doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.