com.aspose.words
Class SaveOptions

java.lang.Object
    extended by com.aspose.words.SaveOptions
Direct Known Subclasses:
DocSaveOptions, FixedPageSaveOptions, HtmlSaveOptions, OdtSaveOptions, OoxmlSaveOptions, RtfSaveOptions, TxtSaveOptions, 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 #Error Cref: M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.Saving.SaveOptions) or string #Error Cref: M:Aspose.Words.Document.Save(System.String,Aspose.Words.Saving.SaveOptions) overloads for the user to define custom options when saving a document.

Property Getters/Setters Summary
intgetColorMode()
voidsetColorMode(int value)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
java.lang.StringgetDefaultTemplate()
voidsetDefaultTemplate(java.lang.String value)
           Gets or sets path to default template (including filename). Default value for this property is #Error Cref: F:System.String.Empty
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 Aspose.Words.SaveFormatgetSaveFormat()
           Specifies the format in which the document will be saved if this save options object is used.
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
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.
Aspose.Words.IWarningCallbackgetWarningCallback()
           Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.
 
Method Summary
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

getColorMode/setColorMode

public int getColorMode() / public void setColorMode(int value)
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL

This property is used when the document is exported to fixed page formats.


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 #Error Cref: F:System.String.EmptyIf specified, this path is used to load template when #Error Cref: P:Aspose.Words.Document.AutomaticallyUpdateSyles is true, but #Error Cref: P:Aspose.Words.Document.AttachedTemplate is empty.

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.


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.


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.

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.


getSaveFormat

public abstract Aspose.Words.SaveFormat getSaveFormat()
Specifies the format in which the document will be saved if this save options object is used.

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.


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 behaviour.

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.

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.

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: #Error Cref: F:Aspose.Words.SaveFormat.Tiff, #Error Cref: F:Aspose.Words.SaveFormat.Png, #Error Cref: F:Aspose.Words.SaveFormat.Bmp, #Error Cref: F:Aspose.Words.SaveFormat.Jpeg, #Error Cref: F:Aspose.Words.SaveFormat.Emf. When the document is exported to the #Error Cref: F:Aspose.Words.SaveFormat.Html, #Error Cref: F:Aspose.Words.SaveFormat.Mhtml and #Error Cref: F:Aspose.Words.SaveFormat.Epub formats this option is used for raster images.


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: #Error Cref: F:Aspose.Words.SaveFormat.Tiff, #Error Cref: F:Aspose.Words.SaveFormat.Png, #Error Cref: F:Aspose.Words.SaveFormat.Bmp, #Error Cref: F:Aspose.Words.SaveFormat.Jpeg, #Error Cref: F:Aspose.Words.SaveFormat.Emf.


getWarningCallback

public Aspose.Words.IWarningCallback getWarningCallback()
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.

This property is obsolete. Please use #Error Cref: P:Aspose.Words.DocumentBase.WarningCallback instead.


Method Detail

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.

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