OoxmlSaveOptions

Inheritance: java.lang.Object, com.aspose.cells.SaveOptions

public class OoxmlSaveOptions extends SaveOptions

Represents the options of saving office open xml file.

Constructors

ConstructorDescription
OoxmlSaveOptions()Creates the options for saving office open xml file.
OoxmlSaveOptions(int saveFormat)Creates the options for saving office open xml file.

Methods

MethodDescription
equals(Object arg0)
getCachedFileFolder()The cached file folder is used to store some large data.
getClass()
getClearData()Make the workbook empty after saving the file.
getCompressionType()Gets the compression type for ooxml file.
getCreateDirectory()If true and the directory does not exist, the directory will be automatically created before saving the file.
getEmbedOoxmlAsOleObject()Indicates whether embedding Ooxml files of OleObject as ole object.
getEnableZip64()Always use ZIP64 extensions when writing zip archives, even when unnecessary.
getExportCellName()Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file.
getLightCellsDataProvider()The data provider for saving workbook in light mode.
getMergeAreas()Indicates whether merge the areas of conditional formatting and validation before saving the file.
getRefreshChartCache()Indicates whether refreshing chart cache data
getSaveFormat()Gets the save file format.
getSortExternalNames()Indicates whether sorting external defined names before saving file.
getSortNames()Indicates whether sorting defined names before saving file.
getUpdateSmartArt()Indicates whether updating smart art setting.
getUpdateZoom()Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
getValidateMergedAreas()Indicates whether validate merged cells before saving the file.
getWarningCallback()Gets warning callback.
hashCode()
notify()
notifyAll()
setCachedFileFolder(String value)The cached file folder is used to store some large data.
setClearData(boolean value)Make the workbook empty after saving the file.
setCompressionType(int value)Sets the compression type for ooxml file.
setCreateDirectory(boolean value)If true and the directory does not exist, the directory will be automatically created before saving the file.
setEmbedOoxmlAsOleObject(boolean value)Indicates whether embedding Ooxml files of OleObject as ole object.
setEnableZip64(boolean value)Always use ZIP64 extensions when writing zip archives, even when unnecessary.
setExportCellName(boolean value)Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file.
setLightCellsDataProvider(LightCellsDataProvider value)The data provider for saving workbook in light mode.
setMergeAreas(boolean value)Indicates whether merge the areas of conditional formatting and validation before saving the file.
setRefreshChartCache(boolean value)Indicates whether refreshing chart cache data
setSortExternalNames(boolean value)Indicates whether sorting external defined names before saving file.
setSortNames(boolean value)Indicates whether sorting defined names before saving file.
setUpdateSmartArt(boolean value)Indicates whether updating smart art setting.
setUpdateZoom(boolean value)Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
setValidateMergedAreas(boolean value)Indicates whether validate merged cells before saving the file.
setWarningCallback(IWarningCallback value)Sets warning callback.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

OoxmlSaveOptions()

public OoxmlSaveOptions()

Creates the options for saving office open xml file.

OoxmlSaveOptions(int saveFormat)

public OoxmlSaveOptions(int saveFormat)

Creates the options for saving office open xml file.

Parameters:

ParameterTypeDescription
saveFormatintSaveFormat. The file format. It should be one of following types: SaveFormat.XLSX, SaveFormat.XLTX, SaveFormat.XLAM, SaveFormat.XLSM or SaveFormat.XLTM, otherwise the saved format will be set as SaveFormat.XLSX automatically.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getCachedFileFolder()

public String getCachedFileFolder()

The cached file folder is used to store some large data.

Returns: java.lang.String

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClearData()

public boolean getClearData()

Make the workbook empty after saving the file.

Returns: boolean

getCompressionType()

public int getCompressionType()

Gets the compression type for ooxml file.

See OoxmlCompressionType.

Remarks

The default value is OoxmlCompressionType.Level2.

Returns: int

getCreateDirectory()

public boolean getCreateDirectory()

If true and the directory does not exist, the directory will be automatically created before saving the file.

Remarks

The default value is false.

Returns: boolean

getEmbedOoxmlAsOleObject()

public boolean getEmbedOoxmlAsOleObject()

Indicates whether embedding Ooxml files of OleObject as ole object.

Remarks

Only for OleObject.

Returns: boolean

getEnableZip64()

public boolean getEnableZip64()

Always use ZIP64 extensions when writing zip archives, even when unnecessary.

Returns: boolean

getExportCellName()

public boolean getExportCellName()

Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is true.

Returns: boolean

getLightCellsDataProvider()

public LightCellsDataProvider getLightCellsDataProvider()

The data provider for saving workbook in light mode.

Returns: LightCellsDataProvider

getMergeAreas()

public boolean getMergeAreas()

Indicates whether merge the areas of conditional formatting and validation before saving the file.

Remarks

The default value is false.

Returns: boolean

getRefreshChartCache()

public boolean getRefreshChartCache()

Indicates whether refreshing chart cache data

Returns: boolean

getSaveFormat()

public int getSaveFormat()

Gets the save file format.

See SaveFormat.

Returns: int

getSortExternalNames()

public boolean getSortExternalNames()

Indicates whether sorting external defined names before saving file.

Returns: boolean

getSortNames()

public boolean getSortNames()

Indicates whether sorting defined names before saving file.

Returns: boolean

getUpdateSmartArt()

public boolean getUpdateSmartArt()

Indicates whether updating smart art setting. The default value is false.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Returns: boolean

getUpdateZoom()

public boolean getUpdateZoom()

Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.

Remarks

The default value is false for performance.

Returns: boolean

getValidateMergedAreas()

public boolean getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Returns: boolean

getWarningCallback()

public IWarningCallback getWarningCallback()

Gets warning callback.

Returns: IWarningCallback

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCachedFileFolder(String value)

public void setCachedFileFolder(String value)

The cached file folder is used to store some large data.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setClearData(boolean value)

public void setClearData(boolean value)

Make the workbook empty after saving the file.

Parameters:

ParameterTypeDescription
valueboolean

setCompressionType(int value)

public void setCompressionType(int value)

Sets the compression type for ooxml file.

See OoxmlCompressionType.

Remarks

The default value is OoxmlCompressionType.Level2.

Parameters:

ParameterTypeDescription
valueint

setCreateDirectory(boolean value)

public void setCreateDirectory(boolean value)

If true and the directory does not exist, the directory will be automatically created before saving the file.

Remarks

The default value is false.

Parameters:

ParameterTypeDescription
valueboolean

setEmbedOoxmlAsOleObject(boolean value)

public void setEmbedOoxmlAsOleObject(boolean value)

Indicates whether embedding Ooxml files of OleObject as ole object.

Remarks

Only for OleObject.

Parameters:

ParameterTypeDescription
valueboolean

setEnableZip64(boolean value)

public void setEnableZip64(boolean value)

Always use ZIP64 extensions when writing zip archives, even when unnecessary.

Parameters:

ParameterTypeDescription
valueboolean

setExportCellName(boolean value)

public void setExportCellName(boolean value)

Indicates if export cell name to Excel2007 .xlsx (.xlsm, .xltx, .xltm) file. If the output file may be accessed by SQL Server DTS, this value must be true. Setting the value to false will highly increase the performance and reduce the file size when creating large file. Default value is true.

Parameters:

ParameterTypeDescription
valueboolean

setLightCellsDataProvider(LightCellsDataProvider value)

public void setLightCellsDataProvider(LightCellsDataProvider value)

The data provider for saving workbook in light mode.

Parameters:

ParameterTypeDescription
valueLightCellsDataProvider

setMergeAreas(boolean value)

public void setMergeAreas(boolean value)

Indicates whether merge the areas of conditional formatting and validation before saving the file.

Remarks

The default value is false.

Parameters:

ParameterTypeDescription
valueboolean

setRefreshChartCache(boolean value)

public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

Parameters:

ParameterTypeDescription
valueboolean

setSortExternalNames(boolean value)

public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

Parameters:

ParameterTypeDescription
valueboolean

setSortNames(boolean value)

public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

Parameters:

ParameterTypeDescription
valueboolean

setUpdateSmartArt(boolean value)

public void setUpdateSmartArt(boolean value)

Indicates whether updating smart art setting. The default value is false.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Parameters:

ParameterTypeDescription
valueboolean

setUpdateZoom(boolean value)

public void setUpdateZoom(boolean value)

Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.

Remarks

The default value is false for performance.

Parameters:

ParameterTypeDescription
valueboolean

setValidateMergedAreas(boolean value)

public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Parameters:

ParameterTypeDescription
valueboolean

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Sets warning callback.

Parameters:

ParameterTypeDescription
valueIWarningCallback

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int