com.aspose.words

Class DocSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.DocSaveOptions

public class DocSaveOptions
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.DOC or SaveFormat.DOT format.

To learn more, visit the Specify Save Options documentation article.

At the moment provides only the getSaveFormat() / setSaveFormat(int) property, but in the future will have other options added, such as an encryption password or digital signature settings.

Constructor Summary

Constructors

Constructor and Description
DocSaveOptions() Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC format.
DocSaveOptions(int saveFormat) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	getAlwaysCompressMetafiles() When false, small metafiles are not compressed for performance reason.
java.lang.String	getPassword() Gets/sets a password to encrypt document using RC4 encryption method.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
boolean	getSavePictureBullet() When false, PictureBullet data is not saved to output document.
boolean	getSaveRoutingSlip() When false, RoutingSlip data is not saved to output document.
void	setAlwaysCompressMetafiles(boolean value) When false, small metafiles are not compressed for performance reason.
void	setPassword(java.lang.String value) Gets/sets a password to encrypt document using RC4 encryption method.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
void	setSavePictureBullet(boolean value) When false, PictureBullet data is not saved to output document.
void	setSaveRoutingSlip(boolean value) When false, RoutingSlip data is not saved to output document.

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocSaveOptions

public DocSaveOptions()

Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC format.

DocSaveOptions

public DocSaveOptions(int saveFormat)

Initializes a new instance of this class.

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.DOC or SaveFormat.DOT.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.DOC or SaveFormat.DOT.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getPassword

public java.lang.String getPassword()

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.

Returns:

The corresponding String value.

setPassword

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.

Parameters:

value - The corresponding String value.

getSaveRoutingSlip

public boolean getSaveRoutingSlip()

When false, RoutingSlip data is not saved to output document. Default value is true.

Returns:

The corresponding boolean value.

setSaveRoutingSlip

public void setSaveRoutingSlip(boolean value)

When false, RoutingSlip data is not saved to output document. Default value is true.

Parameters:

value - The corresponding boolean value.

getAlwaysCompressMetafiles

public boolean getAlwaysCompressMetafiles()

When false, small metafiles are not compressed for performance reason. Default value is true, all metafiles are compressed regardless of its size.

Returns:

The corresponding boolean value.

setAlwaysCompressMetafiles

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

Parameters:

value - The corresponding boolean value.

getSavePictureBullet

public boolean getSavePictureBullet()

When 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".

Returns:

The corresponding boolean value.

setSavePictureBullet

public void setSavePictureBullet(boolean value)

When 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".

Parameters:

value - The corresponding boolean value.