com.aspose.words
Class DocSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by com.aspose.words.DocSaveOptions

public class DocSaveOptions 
extends SaveOptions

Can be used to specify additional options when saving a document into the #Error Cref: F:Aspose.Words.SaveFormat.Doc or #Error Cref: F:Aspose.Words.SaveFormat.Dot format.

At the moment provides only the SaveFormat property, but in the future will have other options added, such as an encryption password or digital signature settings.


Constructor Summary
DocSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the #Error Cref: F:Aspose.Words.SaveFormat.Doc format.
 
Property Getters/Setters Summary
intgetColorMode()→ inherited from SaveOptions
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()→ inherited from SaveOptions
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()→ inherited from SaveOptions
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()→ inherited from SaveOptions
voidsetDmlRenderingMode(int value)
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
booleangetMemoryOptimization()→ inherited from SaveOptions
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.
java.lang.StringgetPassword()
voidsetPassword(java.lang.String value)
           Gets/sets a password to encrypt document using RC4 encryption method.
booleangetPrettyFormat()→ inherited from SaveOptions
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
Aspose.Words.SaveFormatgetSaveFormat()
           Specifies the format in which the document will be saved if this save options object is used. Can be #Error Cref: F:Aspose.Words.SaveFormat.Doc or #Error Cref: F:Aspose.Words.SaveFormat.Dot.
booleangetSaveRoutingSlip()
voidsetSaveRoutingSlip(boolean value)
           When false, RoutingSlip data is not saved to output document. Default value is true.
java.lang.StringgetTempFolder()→ inherited from SaveOptions
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()→ inherited from SaveOptions
voidsetUpdateFields(boolean value)
           Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is true
booleangetUpdateSdtContent()→ inherited from SaveOptions
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()→ inherited from SaveOptions
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()→ inherited from SaveOptions
voidsetUseHighQualityRendering(boolean value)
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
Aspose.Words.IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
           Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.
 

Constructor Detail

DocSaveOptions

public DocSaveOptions()
Initializes a new instance of this class that can be used to save a document in the #Error Cref: F:Aspose.Words.SaveFormat.Doc format.

Property Getters/Setters Detail

getColorMode/setColorMode

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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.

getPassword/setPassword

public java.lang.String getPassword() / public void setPassword(java.lang.String value)
Gets/sets a password to encrypt document using RC4 encryption method.

In order to save document without encryption this property should be null or empty string.


getPrettyFormat/setPrettyFormat

→ inherited from SaveOptions
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 Aspose.Words.SaveFormat getSaveFormat()
Specifies the format in which the document will be saved if this save options object is used. Can be #Error Cref: F:Aspose.Words.SaveFormat.Doc or #Error Cref: F:Aspose.Words.SaveFormat.Dot.

getSaveRoutingSlip/setSaveRoutingSlip

public boolean getSaveRoutingSlip() / public void setSaveRoutingSlip(boolean value)
When false, RoutingSlip data is not saved to output document. Default value is true.

getTempFolder/setTempFolder

→ inherited from SaveOptions
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

→ inherited from SaveOptions
public boolean getUpdateFields() / public void setUpdateFields(boolean value)
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is true

getUpdateSdtContent/setUpdateSdtContent

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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

→ inherited from SaveOptions
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.


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