com.aspose.words

Class OoxmlSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.OoxmlSaveOptions

public class OoxmlSaveOptions
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC format.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getCompliance() Specifies the OOXML version for the output document.
int	getCompressionLevel() Specifies the compression level used to save document.
boolean	getKeepLegacyControlChars() Keeps original representation of legacy control characters.
java.lang.String	getPassword() Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
void	setCompliance(int value) Specifies the OOXML version for the output document.
void	setCompressionLevel(int value) Specifies the compression level used to save document.
void	setKeepLegacyControlChars(boolean value) Keeps original representation of legacy control characters.
void	setPassword(java.lang.String value) Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.

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

OoxmlSaveOptions

public OoxmlSaveOptions()

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

OoxmlSaveOptions

public OoxmlSaveOptions(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.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC.

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.DOCX, SaveFormat.DOCM, SaveFormat.DOTX, SaveFormat.DOTM or SaveFormat.FLAT_OPC.

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 ECMA376 Standard encryption algorithm.

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 ECMA376 Standard encryption algorithm.

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

Parameters:

value - The corresponding String value.

getCompliance

public int getCompliance()

Specifies the OOXML version for the output document. The default value is OoxmlCompliance.ECMA_376_2006.

Returns:

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

setCompliance

public void setCompliance(int value)

Specifies the OOXML version for the output document. The default value is OoxmlCompliance.ECMA_376_2006.

Parameters:

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

getKeepLegacyControlChars

public boolean getKeepLegacyControlChars()

Keeps original representation of legacy control characters.

Returns:

The corresponding boolean value.

setKeepLegacyControlChars

public void setKeepLegacyControlChars(boolean value)

Keeps original representation of legacy control characters.

Parameters:

value - The corresponding boolean value.

getCompressionLevel

public int getCompressionLevel()

Specifies the compression level used to save document. The default value is CompressionLevel.NORMAL.

Returns:

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

setCompressionLevel

public void setCompressionLevel(int value)

Specifies the compression level used to save document. The default value is CompressionLevel.NORMAL.

Parameters:

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