XlsSaveOptions

XlsSaveOptions class

Represents the save options for the Excel 97-2003 file format: xls and xlt.

class XlsSaveOptions extends SaveOptions;

Constructors

Name	Description
constructor()	Creates options for saving Excel 97-2003 xls file.
constructor(SaveOptions)	Constructs from a parent object convertible to this.
constructor(SaveFormat)	Creates options for saving Excel 97-2003 xls/xlt file.

Properties

Property	Type	Description
lightCellsDataProvider	LightCellsDataProvider	The data provider for saving workbook in light mode.
matchColor	boolean	Indicates whether matching font color because there are 56 colors in the standard color palette.
wpsCompatibility	boolean	Indicates whether to make the xls more compatible with WPS.
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.

constructor()

Creates options for saving Excel 97-2003 xls file.

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

Parameter	Type	Description
obj	SaveOptions	The parent object.

constructor(SaveFormat)

Creates options for saving Excel 97-2003 xls/xlt file.

constructor(saveFormat: SaveFormat);

Parameters:

Parameter	Type	Description
saveFormat	SaveFormat	The file format. /// It should be SaveFormat.Excel97To2003 or SaveFormat.Xlt, /// otherwise the saved format will be set as SaveFormat.Excel97To2003 automatically.

lightCellsDataProvider

The data provider for saving workbook in light mode.

lightCellsDataProvider : LightCellsDataProvider;

matchColor

Indicates whether matching font color because there are 56 colors in the standard color palette.

matchColor : boolean;

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.