asposecells.api

Classes

Constants

Class OoxmlSaveOptions

Represents the options of saving office open xml file.

Constructor Summary
`OoxmlSaveOptions()` Creates the options for saving office open xml file.
`OoxmlSaveOptions(saveFormat)` Creates the options for saving office open xml file.

Property Getters/Setters Summary
`method`	`getCachedFileFolder()`
`method`	`setCachedFileFolder(value)`
	The cached file folder is used to store some large data.
`method`	`getClearData()`
`method`	`setClearData(value)`
	Make the workbook empty after saving the file.
`method`	`getCompressionType()`
`method`	`setCompressionType(value)`
	Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.
`method`	`getCreateDirectory()`
`method`	`setCreateDirectory(value)`
	If true and the directory does not exist, the directory will be automatically created before saving the file.
`method`	`getEmbedOoxmlAsOleObject()`
`method`	`setEmbedOoxmlAsOleObject(value)`
	Indicates whether embedding Ooxml files of OleObject as ole object.
`method`	`getEnableZip64()`
`method`	`setEnableZip64(value)`
	Always use ZIP64 extensions when writing zip archives, even when unnecessary.
`method`	`getExportCellName()`
`method`	`setExportCellName(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.
`method`	`getLightCellsDataProvider()`
`method`	`setLightCellsDataProvider(value)`
	The data provider for saving workbook in light mode.
`method`	`getMergeAreas()`
`method`	`setMergeAreas(value)`
	Indicates whether merge the areas of conditional formatting and validation before saving the file.
`method`	`getRefreshChartCache()`
`method`	`setRefreshChartCache(value)`
	Indicates whether refreshing chart cache data
`method`	`getSaveFormat()`
	Gets the save file format. The value of the property is SaveFormat integer constant.
`method`	`getSortExternalNames()`
`method`	`setSortExternalNames(value)`
	Indicates whether sorting external defined names before saving file.
`method`	`getSortNames()`
`method`	`setSortNames(value)`
	Indicates whether sorting defined names before saving file.
`method`	`getUpdateSmartArt()`
`method`	`setUpdateSmartArt(value)`
	Indicates whether updating smart art setting. The default value is false.
`method`	`getUpdateZoom()`
`method`	`setUpdateZoom(value)`
	Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
`method`	`getValidateMergedAreas()`
`method`	`setValidateMergedAreas(value)`
	Indicates whether validate merged cells before saving the file.

- Constructor Detail
  - OoxmlSaveOptions
```
OoxmlSaveOptions()
```
    Creates the options for saving office open xml file.
  - OoxmlSaveOptions
```
OoxmlSaveOptions(saveFormat)
```
    Creates the options for saving office open xml file.
    Parameters:
    saveFormat: int - A SaveFormat value. 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.
- Property Getters/Setters Detail
  - getExportCellName/setExportCellName : boolean
```
boolean getExportCellName() / setExportCellName(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.
  - getLightCellsDataProvider/setLightCellsDataProvider : LightCellsDataProvider
```
LightCellsDataProvider getLightCellsDataProvider() / setLightCellsDataProvider(value)
```
    The data provider for saving workbook in light mode.
  - getUpdateZoom/setUpdateZoom : boolean
```
boolean getUpdateZoom() / setUpdateZoom(value)
```
    Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
    The default value is false for performance.
  - getEnableZip64/setEnableZip64 : boolean
```
boolean getEnableZip64() / setEnableZip64(value)
```
    Always use ZIP64 extensions when writing zip archives, even when unnecessary.
  - getEmbedOoxmlAsOleObject/setEmbedOoxmlAsOleObject : boolean
```
boolean getEmbedOoxmlAsOleObject() / setEmbedOoxmlAsOleObject(value)
```
    Indicates whether embedding Ooxml files of OleObject as ole object.
    Only for OleObject.
  - getCompressionType/setCompressionType : int
```
int getCompressionType() / setCompressionType(value)
```
    Gets and sets the compression type for ooxml file. The value of the property is OoxmlCompressionType integer constant.
    The default value is OoxmlCompressionType.Level2.
  - getSaveFormat : int
```
int getSaveFormat()
```
    Gets the save file format. The value of the property is SaveFormat integer constant.
  - getClearData/setClearData : boolean
```
boolean getClearData() / setClearData(value)
```
    Make the workbook empty after saving the file.
  - getCachedFileFolder/setCachedFileFolder : String
```
String getCachedFileFolder() / setCachedFileFolder(value)
```
    The cached file folder is used to store some large data.
  - getValidateMergedAreas/setValidateMergedAreas : boolean
```
boolean getValidateMergedAreas() / setValidateMergedAreas(value)
```
    Indicates whether validate merged cells before saving the file.
    The default value is false.
  - getMergeAreas/setMergeAreas : boolean
```
boolean getMergeAreas() / setMergeAreas(value)
```
    Indicates whether merge the areas of conditional formatting and validation before saving the file.
    The default value is false.
  - getCreateDirectory/setCreateDirectory : boolean
```
boolean getCreateDirectory() / setCreateDirectory(value)
```
    If true and the directory does not exist, the directory will be automatically created before saving the file.
    The default value is false.
  - getSortNames/setSortNames : boolean
```
boolean getSortNames() / setSortNames(value)
```
    Indicates whether sorting defined names before saving file.
  - getSortExternalNames/setSortExternalNames : boolean
```
boolean getSortExternalNames() / setSortExternalNames(value)
```
    Indicates whether sorting external defined names before saving file.
  - getRefreshChartCache/setRefreshChartCache : boolean
```
boolean getRefreshChartCache() / setRefreshChartCache(value)
```
    Indicates whether refreshing chart cache data
  - getUpdateSmartArt/setUpdateSmartArt : boolean
```
boolean getUpdateSmartArt() / setUpdateSmartArt(value)
```
    Indicates whether updating smart art setting. The default value is false.
    Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

asposecells.api

Classes

Constants

Class OoxmlSaveOptions

Constructor Detail

OoxmlSaveOptions

OoxmlSaveOptions

Property Getters/Setters Detail

getExportCellName/setExportCellName : boolean

getLightCellsDataProvider/setLightCellsDataProvider : LightCellsDataProvider

getUpdateZoom/setUpdateZoom : boolean

getEnableZip64/setEnableZip64 : boolean

getEmbedOoxmlAsOleObject/setEmbedOoxmlAsOleObject : boolean

getCompressionType/setCompressionType : int

getSaveFormat : int

getClearData/setClearData : boolean

getCachedFileFolder/setCachedFileFolder : String

getValidateMergedAreas/setValidateMergedAreas : boolean

getMergeAreas/setMergeAreas : boolean

getCreateDirectory/setCreateDirectory : boolean

getSortNames/setSortNames : boolean

getSortExternalNames/setSortExternalNames : boolean

getRefreshChartCache/setRefreshChartCache : boolean

getUpdateSmartArt/setUpdateSmartArt : boolean