java.lang.ObjectSaveOptions
com.aspose.words.DocSaveOptions
public class DocSaveOptions
At the moment provides only the Example:
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 |
DocSaveOptions(int saveFormat)
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAlwaysCompressMetafiles() | |
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.
|
||
int | getColorMode() | → inherited from SaveOptions |
void | setColorMode(int value) | |
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant. | ||
java.lang.String | getDefaultTemplate() | → inherited from SaveOptions |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename). Default value for this property is empty string. | ||
int | getDmlEffectsRenderingMode() | → inherited from SaveOptions |
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() | → inherited from SaveOptions |
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() | → inherited from SaveOptions |
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. | ||
java.lang.String | getPassword() | |
void | setPassword(java.lang.String value) | |
Gets/sets a password to encrypt document using RC4 encryption method. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
int | getSaveFormat() | |
void | setSaveFormat(int value) | |
Specifies the format in which the document will be saved if this save options object is used.
Can be |
||
boolean | getSavePictureBullet() | |
void | setSavePictureBullet(boolean value) | |
When false , PictureBullet data is not saved to output document.
Default value is true.
|
||
boolean | getSaveRoutingSlip() | |
void | setSaveRoutingSlip(boolean value) | |
When false , RoutingSlip data is not saved to output document.
Default value is true.
|
||
java.lang.String | getTempFolder() | → inherited from SaveOptions |
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() | → inherited from SaveOptions |
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 | getUpdateLastSavedTimeProperty() | → inherited from SaveOptions |
void | setUpdateLastSavedTimeProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateSdtContent() | → inherited from SaveOptions |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | → inherited from SaveOptions |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseHighQualityRendering() | → inherited from SaveOptions |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
Constructor Detail |
---|
public DocSaveOptions()
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);
public DocSaveOptions(int saveFormat)
saveFormat
- A 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) |
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 | → inherited from SaveOptions |
public int getColorMode() / public void setColorMode(int value) |
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 | → inherited from SaveOptions |
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.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 | → inherited from SaveOptions |
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 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 | → inherited from SaveOptions |
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 define rendering for DML shapesDocument 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 | → inherited from SaveOptions |
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() + "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) |
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 | → inherited from SaveOptions |
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.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) |
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) |
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) |
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 | → inherited from SaveOptions |
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.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 | → inherited from SaveOptions |
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() + "UpdateFields_False.pdf", pdfSaveOptions);
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value) |
Example:
Shows how to update a document time property when you want to save itDocument 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 | → inherited from SaveOptions |
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() + "UpdateSdtContent.pdf", options);
getUseAntiAliasing/setUseAntiAliasing | → inherited from SaveOptions |
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:
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 | → inherited from SaveOptions |
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value) |
false
.
This property is used when the document is exported to image formats:
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);