SpreadsheetML2003SaveOptions
SpreadsheetML2003SaveOptions class
Represents the options for saving Excel 2003 spreadml file.
class SpreadsheetML2003SaveOptions extends SaveOptions;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Creates the options for saving Excel 2003 spreadml file. |
| constructor(SaveOptions) | Constructs from a parent object convertible to this. |
Properties
| Property | Type | Description |
|---|---|---|
| isIndentedFormatting | boolean | Causes child elements to be indented. |
| limitAsXls | boolean | Limit as xls, the max row index is 65535 and the max column index is 255. |
| exportColumnIndexOfCell | boolean | The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell. |
| saveFormat | SaveFormat | Readonly. Gets the save file format. |
| clearData | boolean | Make the workbook empty after saving the file. |
| cachedFileFolder | string | The folder for temporary files that may be used as data cache. |
| validateMergedAreas | boolean | Indicates whether validate merged cells before saving the file. |
| mergeAreas | boolean | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| createDirectory | boolean | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| sortNames | boolean | Indicates whether sorting defined names before saving file. |
| sortExternalNames | boolean | Indicates whether sorting external defined names before saving file. |
| refreshChartCache | boolean | Indicates whether refreshing chart cache data |
| warningCallback | IWarningCallback | Gets or sets warning callback. |
| checkExcelRestriction | boolean | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
| updateSmartArt | boolean | Indicates whether updating smart art setting. The default value is false. |
| encryptDocumentProperties | boolean | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
Methods
| Method | Description |
|---|---|
| isIndentedFormatting() | @deprecated. Please use the ‘isIndentedFormatting’ property instead. Causes child elements to be indented. |
| setIsIndentedFormatting(boolean) | @deprecated. Please use the ‘isIndentedFormatting’ property instead. Causes child elements to be indented. |
| getLimitAsXls() | @deprecated. Please use the ’limitAsXls’ property instead. Limit as xls, the max row index is 65535 and the max column index is 255. |
| setLimitAsXls(boolean) | @deprecated. Please use the ’limitAsXls’ property instead. Limit as xls, the max row index is 65535 and the max column index is 255. |
| getExportColumnIndexOfCell() | @deprecated. Please use the ’exportColumnIndexOfCell’ property instead. The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell. |
| setExportColumnIndexOfCell(boolean) | @deprecated. Please use the ’exportColumnIndexOfCell’ property instead. The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell. |
| isNull() | Checks whether the implementation object is null. |
| getSaveFormat() | @deprecated. Please use the ‘saveFormat’ property instead. Gets the save file format. |
| getClearData() | @deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file. |
| setClearData(boolean) | @deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file. |
| getCachedFileFolder() | @deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache. |
| setCachedFileFolder(string) | @deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache. |
| getValidateMergedAreas() | @deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file. |
| setValidateMergedAreas(boolean) | @deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file. |
| getMergeAreas() | @deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| setMergeAreas(boolean) | @deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| getCreateDirectory() | @deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file. |
| setCreateDirectory(boolean) | @deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file. |
| getSortNames() | @deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file. |
| setSortNames(boolean) | @deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file. |
| getSortExternalNames() | @deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file. |
| setSortExternalNames(boolean) | @deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file. |
| getRefreshChartCache() | @deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data |
| setRefreshChartCache(boolean) | @deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data |
| setWarningCallback(IWarningCallback) | @deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback. |
| getWarningCallback() | @deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback. |
| getCheckExcelRestriction() | @deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
| setCheckExcelRestriction(boolean) | @deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
| getUpdateSmartArt() | @deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false. |
| setUpdateSmartArt(boolean) | @deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false. |
| getEncryptDocumentProperties() | @deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
| setEncryptDocumentProperties(boolean) | @deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
constructor()
Creates the options for saving Excel 2003 spreadml file.
constructor();
constructor(SaveOptions)
Constructs from a parent object convertible to this.
constructor(obj: SaveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | SaveOptions | The parent object. |
isIndentedFormatting
Causes child elements to be indented.
isIndentedFormatting : boolean;
Remarks
The default value is true. If the value is false, it will reduce the size of the xml file
limitAsXls
Limit as xls, the max row index is 65535 and the max column index is 255.
limitAsXls : boolean;
exportColumnIndexOfCell
The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell.
exportColumnIndexOfCell : boolean;
saveFormat
Readonly. Gets the save file format.
saveFormat : SaveFormat;
clearData
Make the workbook empty after saving the file.
clearData : boolean;
cachedFileFolder
The folder for temporary files that may be used as data cache.
cachedFileFolder : string;
Remarks
If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.
validateMergedAreas
Indicates whether validate merged cells before saving the file.
validateMergedAreas : boolean;
Remarks
The default value is false.
mergeAreas
Indicates whether merge the areas of conditional formatting and validation before saving the file.
mergeAreas : boolean;
Remarks
The default value is false.
createDirectory
If true and the directory does not exist, the directory will be automatically created before saving the file.
createDirectory : boolean;
Remarks
The default value is false.
sortNames
Indicates whether sorting defined names before saving file.
sortNames : boolean;
sortExternalNames
Indicates whether sorting external defined names before saving file.
sortExternalNames : boolean;
refreshChartCache
Indicates whether refreshing chart cache data
refreshChartCache : boolean;
warningCallback
Gets or sets warning callback.
warningCallback : IWarningCallback;
checkExcelRestriction
Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
checkExcelRestriction : boolean;
updateSmartArt
Indicates whether updating smart art setting. The default value is false.
updateSmartArt : boolean;
Remarks
Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
encryptDocumentProperties
Indicates whether encrypt document properties when saving as .xls file. The default value is true.
encryptDocumentProperties : boolean;
Remarks
Only for .xls,xlsx,xlsb and xlsm file.
isIndentedFormatting()
@deprecated. Please use the ‘isIndentedFormatting’ property instead. Causes child elements to be indented.
isIndentedFormatting() : boolean;
Remarks
The default value is true. If the value is false, it will reduce the size of the xml file
setIsIndentedFormatting(boolean)
@deprecated. Please use the ‘isIndentedFormatting’ property instead. Causes child elements to be indented.
setIsIndentedFormatting(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is true. If the value is false, it will reduce the size of the xml file
getLimitAsXls()
@deprecated. Please use the ’limitAsXls’ property instead. Limit as xls, the max row index is 65535 and the max column index is 255.
getLimitAsXls() : boolean;
setLimitAsXls(boolean)
@deprecated. Please use the ’limitAsXls’ property instead. Limit as xls, the max row index is 65535 and the max column index is 255.
setLimitAsXls(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getExportColumnIndexOfCell()
@deprecated. Please use the ’exportColumnIndexOfCell’ property instead. The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell.
getExportColumnIndexOfCell() : boolean;
setExportColumnIndexOfCell(boolean)
@deprecated. Please use the ’exportColumnIndexOfCell’ property instead. The default value is false, it means that column index will be ignored if the cell is contiguous to the previous cell.
setExportColumnIndexOfCell(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getSaveFormat()
@deprecated. Please use the ‘saveFormat’ property instead. Gets the save file format.
getSaveFormat() : SaveFormat;
Returns
getClearData()
@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.
getClearData() : boolean;
setClearData(boolean)
@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.
setClearData(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getCachedFileFolder()
@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.
getCachedFileFolder() : string;
Remarks
If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.
setCachedFileFolder(string)
@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.
setCachedFileFolder(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.
getValidateMergedAreas()
@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.
getValidateMergedAreas() : boolean;
Remarks
The default value is false.
setValidateMergedAreas(boolean)
@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.
setValidateMergedAreas(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is false.
getMergeAreas()
@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.
getMergeAreas() : boolean;
Remarks
The default value is false.
setMergeAreas(boolean)
@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.
setMergeAreas(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is false.
getCreateDirectory()
@deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file.
getCreateDirectory() : boolean;
Remarks
The default value is false.
setCreateDirectory(boolean)
@deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file.
setCreateDirectory(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The default value is false.
getSortNames()
@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.
getSortNames() : boolean;
setSortNames(boolean)
@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.
setSortNames(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getSortExternalNames()
@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.
getSortExternalNames() : boolean;
setSortExternalNames(boolean)
@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.
setSortExternalNames(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRefreshChartCache()
@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data
getRefreshChartCache() : boolean;
setRefreshChartCache(boolean)
@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data
setRefreshChartCache(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
setWarningCallback(IWarningCallback)
@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
setWarningCallback(value: IWarningCallback) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback | The value to set. |
getWarningCallback()
@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
getWarningCallback() : IWarningCallback;
Returns
getCheckExcelRestriction()
@deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
getCheckExcelRestriction() : boolean;
setCheckExcelRestriction(boolean)
@deprecated. Please use the ‘checkExcelRestriction’ property instead. Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
setCheckExcelRestriction(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getUpdateSmartArt()
@deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false.
getUpdateSmartArt() : boolean;
Remarks
Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
setUpdateSmartArt(boolean)
@deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false.
setUpdateSmartArt(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.
getEncryptDocumentProperties()
@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.
getEncryptDocumentProperties() : boolean;
Remarks
Only for .xls,xlsx,xlsb and xlsm file.
setEncryptDocumentProperties(boolean)
@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.
setEncryptDocumentProperties(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Only for .xls,xlsx,xlsb and xlsm file.