DifSaveOptions
DifSaveOptions class
Represents the options of saving dif file.
class DifSaveOptions extends SaveOptions;
Constructors
| Name | Description |
|---|---|
| constructor() | Creates the options for saving DIF file. |
| constructor(SaveOptions) | Constructs from a parent object convertible to this. |
Methods
| Method | Description |
|---|---|
| isNull() | Checks whether the implementation object is null. |
| getSaveFormat() | Gets the save file format. |
| getClearData() | Make the workbook empty after saving the file. |
| setClearData(boolean) | Make the workbook empty after saving the file. |
| getCachedFileFolder() | The cached file folder is used to store some large data. |
| setCachedFileFolder(string) | The cached file folder is used to store some large data. |
| getValidateMergedAreas() | Indicates whether validate merged cells before saving the file. |
| setValidateMergedAreas(boolean) | Indicates whether validate merged cells before saving the file. |
| getMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| setMergeAreas(boolean) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| getCreateDirectory() | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| setCreateDirectory(boolean) | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| getSortNames() | Indicates whether sorting defined names before saving file. |
| setSortNames(boolean) | Indicates whether sorting defined names before saving file. |
| getSortExternalNames() | Indicates whether sorting external defined names before saving file. |
| setSortExternalNames(boolean) | Indicates whether sorting external defined names before saving file. |
| getRefreshChartCache() | Indicates whether refreshing chart cache data |
| setRefreshChartCache(boolean) | Indicates whether refreshing chart cache data |
| setWarningCallback(IWarningCallback) | Gets or sets warning callback. |
| getWarningCallback() | Gets or sets warning callback. |
| getCheckExcelRestriction() | 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) | 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() | Indicates whether updating smart art setting. The default value is false. |
| setUpdateSmartArt(boolean) | Indicates whether updating smart art setting. The default value is false. |
| getEncryptDocumentProperties() | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
| setEncryptDocumentProperties(boolean) | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
constructor()
Creates the options for saving DIF file.
constructor();
constructor(SaveOptions)
Constructs from a parent object convertible to this.
constructor(obj: SaveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | SaveOptions | The parent object. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getSaveFormat()
Gets the save file format.
getSaveFormat() : SaveFormat;
Returns
getClearData()
Make the workbook empty after saving the file.
getClearData() : boolean;
setClearData(boolean)
Make the workbook empty after saving the file.
setClearData(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getCachedFileFolder()
The cached file folder is used to store some large data.
getCachedFileFolder() : string;
setCachedFileFolder(string)
The cached file folder is used to store some large data.
setCachedFileFolder(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getValidateMergedAreas()
Indicates whether validate merged cells before saving the file.
getValidateMergedAreas() : boolean;
Remarks
The default value is false.
setValidateMergedAreas(boolean)
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()
Indicates whether merge the areas of conditional formatting and validation before saving the file.
getMergeAreas() : boolean;
Remarks
The default value is false.
setMergeAreas(boolean)
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()
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)
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()
Indicates whether sorting defined names before saving file.
getSortNames() : boolean;
setSortNames(boolean)
Indicates whether sorting defined names before saving file.
setSortNames(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getSortExternalNames()
Indicates whether sorting external defined names before saving file.
getSortExternalNames() : boolean;
setSortExternalNames(boolean)
Indicates whether sorting external defined names before saving file.
setSortExternalNames(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRefreshChartCache()
Indicates whether refreshing chart cache data
getRefreshChartCache() : boolean;
setRefreshChartCache(boolean)
Indicates whether refreshing chart cache data
setRefreshChartCache(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
setWarningCallback(IWarningCallback)
Gets or sets warning callback.
setWarningCallback(value: IWarningCallback) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback | The value to set. |
getWarningCallback()
Gets or sets warning callback.
getWarningCallback() : IWarningCallback;
Returns
getCheckExcelRestriction()
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)
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()
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)
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()
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)
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.