OoxmlSaveOptions

OoxmlSaveOptions class

Represents the options of saving office open xml file.

class OoxmlSaveOptions extends SaveOptions;

Constructors

ConstructorDescription
constructor()Creates the options for saving office open xml file.
constructor(SaveOptions)Constructs from a parent object convertible to this.
constructor(SaveFormat)Creates the options for saving office open xml file.

Properties

PropertyTypeDescription
asFlatOpcbooleanIndicates whether saving as a flat opc file which can be generated by Open XML SDK.
exportCellNamebooleanIndicates 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.
lightCellsDataProviderLightCellsDataProviderThe data provider for saving workbook in light mode.
updateZoombooleanIndicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
enableZip64booleanAlways use ZIP64 extensions when writing zip archives, even when unnecessary.
embedOoxmlAsOleObjectbooleanIndicates whether embedding Ooxml files of OleObject as ole object.
compressionTypeOoxmlCompressionTypeGets and sets the compression type for ooxml file.
wpsCompatibilitybooleanIndicates whether to make the xls more compatible with WPS.
saveFormatSaveFormatReadonly. Gets the save file format.
clearDatabooleanMake the workbook empty after saving the file.
cachedFileFolderstringThe folder for temporary files that may be used as data cache.
validateMergedAreasbooleanIndicates whether validate merged cells before saving the file.
mergeAreasbooleanIndicates whether merge the areas of conditional formatting and validation before saving the file.
createDirectorybooleanIf true and the directory does not exist, the directory will be automatically created before saving the file.
sortNamesbooleanIndicates whether sorting defined names before saving file.
sortExternalNamesbooleanIndicates whether sorting external defined names before saving file.
refreshChartCachebooleanIndicates whether refreshing chart cache data
warningCallbackIWarningCallbackGets or sets warning callback.
checkExcelRestrictionbooleanWhether 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.
updateSmartArtbooleanIndicates whether updating smart art setting. The default value is false.
encryptDocumentPropertiesbooleanIndicates whether encrypt document properties when saving as .xls file. The default value is true.

Methods

MethodDescription
getAsFlatOpc()@deprecated. Please use the ‘asFlatOpc’ property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK.
setAsFlatOpc(boolean)@deprecated. Please use the ‘asFlatOpc’ property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK.
getExportCellName()@deprecated. Please use the ’exportCellName’ property instead. 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.
setExportCellName(boolean)@deprecated. Please use the ’exportCellName’ property instead. 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()@deprecated. Please use the ’lightCellsDataProvider’ property instead. The data provider for saving workbook in light mode.
setLightCellsDataProvider(LightCellsDataProvider)@deprecated. Please use the ’lightCellsDataProvider’ property instead. The data provider for saving workbook in light mode.
getUpdateZoom()@deprecated. Please use the ‘updateZoom’ property instead. Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
setUpdateZoom(boolean)@deprecated. Please use the ‘updateZoom’ property instead. Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.
getEnableZip64()@deprecated. Please use the ’enableZip64’ property instead. Always use ZIP64 extensions when writing zip archives, even when unnecessary.
setEnableZip64(boolean)@deprecated. Please use the ’enableZip64’ property instead. Always use ZIP64 extensions when writing zip archives, even when unnecessary.
getEmbedOoxmlAsOleObject()@deprecated. Please use the ’embedOoxmlAsOleObject’ property instead. Indicates whether embedding Ooxml files of OleObject as ole object.
setEmbedOoxmlAsOleObject(boolean)@deprecated. Please use the ’embedOoxmlAsOleObject’ property instead. Indicates whether embedding Ooxml files of OleObject as ole object.
getCompressionType()@deprecated. Please use the ‘compressionType’ property instead. Gets and sets the compression type for ooxml file.
setCompressionType(OoxmlCompressionType)@deprecated. Please use the ‘compressionType’ property instead. Gets and sets the compression type for ooxml file.
getWpsCompatibility()@deprecated. Please use the ‘wpsCompatibility’ property instead. Indicates whether to make the xls more compatible with WPS.
setWpsCompatibility(boolean)@deprecated. Please use the ‘wpsCompatibility’ property instead. Indicates whether to make the xls more compatible with WPS.
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 office open xml file.

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

ParameterTypeDescription
objSaveOptionsThe parent object.

constructor(SaveFormat)

Creates the options for saving office open xml file.

constructor(saveFormat: SaveFormat);

Parameters:

ParameterTypeDescription
saveFormatSaveFormatThe 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.

asFlatOpc

Indicates whether saving as a flat opc file which can be generated by Open XML SDK.

asFlatOpc : boolean;

exportCellName

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.

exportCellName : boolean;

lightCellsDataProvider

The data provider for saving workbook in light mode.

lightCellsDataProvider : LightCellsDataProvider;

updateZoom

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

updateZoom : boolean;

Remarks

The default value is false for performance.

enableZip64

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

enableZip64 : boolean;

embedOoxmlAsOleObject

Indicates whether embedding Ooxml files of OleObject as ole object.

embedOoxmlAsOleObject : boolean;

Remarks

Only for OleObject.

compressionType

Gets and sets the compression type for ooxml file.

compressionType : OoxmlCompressionType;

Remarks

The default value is OoxmlCompressionType.Level2.

wpsCompatibility

Indicates whether to make the xls more compatible with WPS.

wpsCompatibility : 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.

getAsFlatOpc()

@deprecated. Please use the ‘asFlatOpc’ property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK.

getAsFlatOpc() : boolean;

setAsFlatOpc(boolean)

@deprecated. Please use the ‘asFlatOpc’ property instead. Indicates whether saving as a flat opc file which can be generated by Open XML SDK.

setAsFlatOpc(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExportCellName()

@deprecated. Please use the ’exportCellName’ property instead. 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.

getExportCellName() : boolean;

setExportCellName(boolean)

@deprecated. Please use the ’exportCellName’ property instead. 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.

setExportCellName(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getLightCellsDataProvider()

@deprecated. Please use the ’lightCellsDataProvider’ property instead. The data provider for saving workbook in light mode.

getLightCellsDataProvider() : LightCellsDataProvider;

Returns

LightCellsDataProvider

setLightCellsDataProvider(LightCellsDataProvider)

@deprecated. Please use the ’lightCellsDataProvider’ property instead. The data provider for saving workbook in light mode.

setLightCellsDataProvider(value: LightCellsDataProvider) : void;

Parameters:

ParameterTypeDescription
valueLightCellsDataProviderThe value to set.

getUpdateZoom()

@deprecated. Please use the ‘updateZoom’ property instead. Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.

getUpdateZoom() : boolean;

Remarks

The default value is false for performance.

setUpdateZoom(boolean)

@deprecated. Please use the ‘updateZoom’ property instead. Indicates whether update scaling factor before saving the file if the PageSetup.FitToPagesWide and PageSetup.FitToPagesTall properties control how the worksheet is scaled.

setUpdateZoom(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is false for performance.

getEnableZip64()

@deprecated. Please use the ’enableZip64’ property instead. Always use ZIP64 extensions when writing zip archives, even when unnecessary.

getEnableZip64() : boolean;

setEnableZip64(boolean)

@deprecated. Please use the ’enableZip64’ property instead. Always use ZIP64 extensions when writing zip archives, even when unnecessary.

setEnableZip64(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getEmbedOoxmlAsOleObject()

@deprecated. Please use the ’embedOoxmlAsOleObject’ property instead. Indicates whether embedding Ooxml files of OleObject as ole object.

getEmbedOoxmlAsOleObject() : boolean;

Remarks

Only for OleObject.

setEmbedOoxmlAsOleObject(boolean)

@deprecated. Please use the ’embedOoxmlAsOleObject’ property instead. Indicates whether embedding Ooxml files of OleObject as ole object.

setEmbedOoxmlAsOleObject(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Only for OleObject.

getCompressionType()

@deprecated. Please use the ‘compressionType’ property instead. Gets and sets the compression type for ooxml file.

getCompressionType() : OoxmlCompressionType;

Returns

OoxmlCompressionType

Remarks

The default value is OoxmlCompressionType.Level2.

setCompressionType(OoxmlCompressionType)

@deprecated. Please use the ‘compressionType’ property instead. Gets and sets the compression type for ooxml file.

setCompressionType(value: OoxmlCompressionType) : void;

Parameters:

ParameterTypeDescription
valueOoxmlCompressionTypeThe value to set.

Remarks

The default value is OoxmlCompressionType.Level2.

getWpsCompatibility()

@deprecated. Please use the ‘wpsCompatibility’ property instead. Indicates whether to make the xls more compatible with WPS.

getWpsCompatibility() : boolean;

setWpsCompatibility(boolean)

@deprecated. Please use the ‘wpsCompatibility’ property instead. Indicates whether to make the xls more compatible with WPS.

setWpsCompatibility(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe 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

SaveFormat

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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuestringThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

setWarningCallback(IWarningCallback)

@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.

setWarningCallback(value: IWarningCallback) : void;

Parameters:

ParameterTypeDescription
valueIWarningCallbackThe value to set.

getWarningCallback()

@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.