SaveOptions
Overview
SaveOptions is a class in Aspose.Words FOSS for Java.
This is an abstract base class for classes that allow the user to specify additional options when saving a document into a particular format.
Edition status of its 64 listed members (a property and its accessor methods are listed separately, overloads once): 1 limited, 63 not yet exercised by a verified example.
This class declares 44 methods for SaveOptions objects in Java programs.
Available methods include: createSaveOptions, getAllowEmbeddingPostScriptFonts, getCustomTimeZoneInfo, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, and 31 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: allowEmbeddingPostScriptFonts, customTimeZoneInfo, defaultTemplate, dml3DEffectsRenderingMode, dmlEffectsRenderingMode, dmlRenderingMode, and 15 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
saveFormat | int | Read/Write | Specifies the format in which the document will be saved if this save options object is used. |
exportGeneratorName | boolean | Read/Write | When true, causes the name and version of Aspose.Words to be embedded into produced files. |
tempFolder | String | Read/Write | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
updateOleControlImages | boolean | Read/Write | Gets or sets a value determining whether OLE controls presentation image will be updated. |
prettyFormat | boolean | Read/Write | When true, pretty formats output where applicable. |
useAntiAliasing | boolean | Read/Write | Gets or sets a value determining whether or not to use anti-aliasing for rendering. |
useHighQualityRendering | boolean | Read/Write | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
dmlRenderingMode | int | Read/Write | Gets or sets a value determining how DrawingML shapes are rendered. |
dmlEffectsRenderingMode | int | Read/Write | Gets or sets a value determining how DrawingML effects are rendered. |
imlRenderingMode | int | Read/Write | Gets or sets a value determining how ink (InkML) objects are rendered. |
defaultTemplate | String | Read/Write | Gets or sets path to default template (including filename). |
updateFields | boolean | Read/Write | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
updateLastSavedTimeProperty | boolean | Read/Write | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving. |
updateLastPrintedProperty | boolean | Read/Write | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving. |
updateCreatedTimeProperty | boolean | Read/Write | Gets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving. |
memoryOptimization | boolean | Read/Write | Gets or sets value determining if memory optimization should be performed before saving the document. |
updateAmbiguousTextFont | boolean | Read/Write | Determines whether the font attributes will be changed according to the character code being used. |
dml3DEffectsRenderingMode | int | Read/Write | Gets or sets a value determining how 3D effects are rendered. |
progressCallback | IDocumentSavingCallback | Read/Write | Called during saving a document and accepts data about saving progress. |
allowEmbeddingPostScriptFonts | boolean | Read/Write | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
customTimeZoneInfo | TimeZone | Read/Write | Gets or sets custom local time zone used for date/time fields. |
Methods
| Signature | Description |
|---|---|
getSaveFormat() → int | Specifies the format in which the document will be saved if this save options object is used. |
setSaveFormat(value: int) | Sets the save format value. |
getExportGeneratorName() → boolean | When true, causes the name and version of Aspose.Words to be embedded into produced files. |
setExportGeneratorName(value: boolean) | Sets the export generator name value. |
getTempFolder() → String | Specifies the folder for temporary files used when saving to a DOC or DOCX file. |
setTempFolder(value: String) | Sets the temp folder value. |
getUpdateOleControlImages() → boolean | Gets or sets a value determining whether OLE controls presentation image will be updated. |
setUpdateOleControlImages(value: boolean) | Sets the update ole control images value. |
getPrettyFormat() → boolean | When true, pretty formats output where applicable. |
setPrettyFormat(value: boolean) | Sets the pretty format value. |
getUseAntiAliasing() → boolean | Gets or sets a value determining whether or not to use anti-aliasing for rendering. |
setUseAntiAliasing(value: boolean) | Sets the use anti aliasing value. |
getUseHighQualityRendering() → boolean | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. |
setUseHighQualityRendering(value: boolean) | Sets the use high quality rendering value. |
getDmlRenderingMode() → int | Gets or sets a value determining how DrawingML shapes are rendered. |
setDmlRenderingMode(value: int) | Sets the dml rendering mode value. |
getDmlEffectsRenderingMode() → int | Gets or sets a value determining how DrawingML effects are rendered. |
setDmlEffectsRenderingMode(value: int) | Sets the dml effects rendering mode value. |
getImlRenderingMode() → int | Gets or sets a value determining how ink (InkML) objects are rendered. |
setImlRenderingMode(value: int) | Sets the iml rendering mode value. |
getDefaultTemplate() → String | Gets or sets path to default template (including filename). |
setDefaultTemplate(value: String) | Sets the default template value. |
getUpdateFields() → boolean | Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. |
setUpdateFields(value: boolean) | Sets the update fields value. |
getUpdateLastSavedTimeProperty() → boolean | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving. |
setUpdateLastSavedTimeProperty(value: boolean) | Sets the update last saved time property value. |
getUpdateLastPrintedProperty() → boolean | Gets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving. |
setUpdateLastPrintedProperty(value: boolean) | Sets the update last printed property value. |
getUpdateCreatedTimeProperty() → boolean | Gets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving. |
setUpdateCreatedTimeProperty(value: boolean) | Sets the update created time property value. |
getMemoryOptimization() → boolean | Gets or sets value determining if memory optimization should be performed before saving the document. |
setMemoryOptimization(value: boolean) | Sets the memory optimization value. |
getUpdateAmbiguousTextFont() → boolean | Determines whether the font attributes will be changed according to the character code being used. |
setUpdateAmbiguousTextFont(value: boolean) | Sets the update ambiguous text font value. |
createSaveOptions(saveFormat: int) → SaveOptions | Limited in the FOSS edition — some inputs are rejected. Creates a save options object of a class suitable for the specified save format. |
createSaveOptions(fileName: String) → SaveOptions | Limited in the FOSS edition — some inputs are rejected. Creates a save options object of a class suitable for the file extension specified in the given file name. |
getDml3DEffectsRenderingMode() → int | Gets or sets a value determining how 3D effects are rendered. |
setDml3DEffectsRenderingMode(value: int) | Sets the dml3 d effects rendering mode value. |
getProgressCallback() → IDocumentSavingCallback | Called during saving a document and accepts data about saving progress. |
setProgressCallback(value: IDocumentSavingCallback) | Sets the progress callback value. |
getAllowEmbeddingPostScriptFonts() → boolean | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. |
setAllowEmbeddingPostScriptFonts(value: boolean) | Sets the allow embedding post script fonts value. |
getCustomTimeZoneInfo() → TimeZone | Gets or sets custom local time zone used for date/time fields. |
setCustomTimeZoneInfo(value: TimeZone) | Sets the custom time zone info value. |