java.lang.Objectcom.aspose.words.SaveOptions
public abstract class SaveOptions
Example:
// 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.String | getDefaultTemplate() | |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename). Default value for this property is empty string. | ||
int | getDml3DEffectsRenderingMode() | |
void | setDml3DEffectsRenderingMode(int value) | |
Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. | ||
int | getDmlEffectsRenderingMode() | |
void | setDmlEffectsRenderingMode(int value) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | |
void | setDmlRenderingMode(int value) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
boolean | getMemoryOptimization() | |
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. | ||
boolean | getPrettyFormat() | |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
abstract int | getSaveFormat() | |
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. | ||
java.lang.String | getTempFolder() | |
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.
|
||
boolean | getUpdateFields() | |
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. | ||
boolean | getUpdateLastPrintedProperty() | |
void | setUpdateLastPrintedProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateLastSavedTimeProperty() | |
void | setUpdateLastSavedTimeProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateSdtContent() | |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseHighQualityRendering() | |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
Method Summary | ||
---|---|---|
static SaveOptions | createSaveOptions(int saveFormat) | |
Creates a save options object of a class suitable for the specified save format. | ||
static SaveOptions | createSaveOptions(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) |
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) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
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"); // 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); options.setDmlRenderingMode(DmlRenderingMode.FALLBACK); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.pdf", options);
getDmlRenderingMode/setDmlRenderingMode | |
public int getDmlRenderingMode() / public void setDmlRenderingMode(int value) |
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"); // 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); options.setDmlRenderingMode(DmlRenderingMode.FALLBACK); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.pdf", options);
getMemoryOptimization/setMemoryOptimization | |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
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) |
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) |
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) |
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
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) |
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() + "PdfSaveOptions.WithoutUpdateFields.pdf", pdfSaveOptions);
getUpdateLastPrintedProperty/setUpdateLastPrintedProperty | |
public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value) |
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) |
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) |
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() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
getUseAntiAliasing/setUseAntiAliasing | |
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value) |
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:
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) |
false
.
This property is used when the document is exported to image formats:
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) |
saveFormat
- A 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 |
fileName
- The extension of this file name determines the class of the save options object to create.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);