java.lang.Objectcom.aspose.words.SaveOptions
public abstract class SaveOptions
Property Getters/Setters Summary | ||
---|---|---|
int | getColorMode() | |
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() | |
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() | |
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 | 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 |
---|
getColorMode/setColorMode | |
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(getMyDir() + "\\Artifacts\\ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
getDefaultTemplate/setDefaultTemplate | |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
This property is used when the document is exported to fixed page formats.
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 define rendering for DML shapesDocument doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML); doc.save(getMyDir() + "\\Artifacts\\DrawingMl.pdf", pdfSaveOptions);
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() + "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(getMyDir() + "\\Artifacts\\SaveOptions.MemoryOptimization Out.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.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(getMyDir() + "\\Artifacts\\Document.PrettyFormat.html", htmlOptions);
getSaveFormat/setSaveFormat | |
public abstract int getSaveFormat() / public abstract void setSaveFormat(int value) |
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.
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); doc.save(getMyDir() + "\\Artifacts\\UpdateFields_False.pdf", pdfSaveOptions);
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | |
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);
getUpdateSdtContent/setUpdateSdtContent | |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
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:
getUseHighQualityRendering/setUseHighQualityRendering | |
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value) |
false
.
This property is used when the document is exported to image formats:
Method Detail |
---|
createSaveOptions | |
public static SaveOptions createSaveOptions(int saveFormat) |
saveFormat
- A 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.