JsonSaveOptions

JsonSaveOptions class

Represents the options of saving the workbook as a json file.

class JsonSaveOptions extends SaveOptions;

Constructors

ConstructorDescription
constructor()Creates options for saving json file.
constructor(SaveOptions)Constructs from a parent object convertible to this.

Properties

PropertyTypeDescription
exportStylePoolbooleanIndicates whether to export styles collectively or individually to each cell.
exportHyperlinkTypeJsonExportHyperlinkTypeRepresents the type of exporting hyperlink to json.
skipEmptyRowsbooleanIndicates whether skipping emtpy rows.
sheetIndexesnumber[]Represents the indexes of exported sheets.
schemasstring[]The original json schema of each worksheet.
exportAreaCellAreaGets or sets the exporting range.
hasHeaderRowbooleanIndicates whether the range contains header row.
exportAsStringbooleanExports the string value of the cells to json.
indentstringIndicates the indent.
exportNestedStructurebooleanExported as parent-child hierarchy Json structure.
exportEmptyCellsbooleanIndicates whether exporting empty cells as null.
alwaysExportAsJsonObjectbooleanIndicates whether always exporting excel to json as object, even there is only a worksheet in the file.
toExcelStructbooleanIndicates whether converting to json struct of the Excel file.
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
getExportStylePool()@deprecated. Please use the ’exportStylePool’ property instead. Indicates whether to export styles collectively or individually to each cell.
setExportStylePool(boolean)@deprecated. Please use the ’exportStylePool’ property instead. Indicates whether to export styles collectively or individually to each cell.
getExportHyperlinkType()@deprecated. Please use the ’exportHyperlinkType’ property instead. Represents the type of exporting hyperlink to json.
setExportHyperlinkType(JsonExportHyperlinkType)@deprecated. Please use the ’exportHyperlinkType’ property instead. Represents the type of exporting hyperlink to json.
getSkipEmptyRows()@deprecated. Please use the ‘skipEmptyRows’ property instead. Indicates whether skipping emtpy rows.
setSkipEmptyRows(boolean)@deprecated. Please use the ‘skipEmptyRows’ property instead. Indicates whether skipping emtpy rows.
getSheetIndexes()@deprecated. Please use the ‘sheetIndexes’ property instead. Represents the indexes of exported sheets.
setSheetIndexes(number[])@deprecated. Please use the ‘sheetIndexes’ property instead. Represents the indexes of exported sheets.
getSchemas()@deprecated. Please use the ‘schemas’ property instead. The original json schema of each worksheet.
setSchemas(string[])@deprecated. Please use the ‘schemas’ property instead. The original json schema of each worksheet.
getExportArea()@deprecated. Please use the ’exportArea’ property instead. Gets or sets the exporting range.
setExportArea(CellArea)@deprecated. Please use the ’exportArea’ property instead. Gets or sets the exporting range.
getHasHeaderRow()@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.
setHasHeaderRow(boolean)@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.
getExportAsString()@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.
setExportAsString(boolean)@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.
getIndent()@deprecated. Please use the ‘indent’ property instead. Indicates the indent.
setIndent(string)@deprecated. Please use the ‘indent’ property instead. Indicates the indent.
getExportNestedStructure()@deprecated. Please use the ’exportNestedStructure’ property instead. Exported as parent-child hierarchy Json structure.
setExportNestedStructure(boolean)@deprecated. Please use the ’exportNestedStructure’ property instead. Exported as parent-child hierarchy Json structure.
getExportEmptyCells()@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.
setExportEmptyCells(boolean)@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.
getAlwaysExportAsJsonObject()@deprecated. Please use the ‘alwaysExportAsJsonObject’ property instead. Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
setAlwaysExportAsJsonObject(boolean)@deprecated. Please use the ‘alwaysExportAsJsonObject’ property instead. Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.
getToExcelStruct()@deprecated. Please use the ’toExcelStruct’ property instead. Indicates whether converting to json struct of the Excel file.
setToExcelStruct(boolean)@deprecated. Please use the ’toExcelStruct’ property instead. Indicates whether converting to json struct of the Excel file.
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 options for saving json file.

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

ParameterTypeDescription
objSaveOptionsThe parent object.

exportStylePool

Indicates whether to export styles collectively or individually to each cell.

exportStylePool : boolean;

exportHyperlinkType

Represents the type of exporting hyperlink to json.

exportHyperlinkType : JsonExportHyperlinkType;

Remarks

The default value is JsonExportHyperlinkType.DisplayString;

skipEmptyRows

Indicates whether skipping emtpy rows.

skipEmptyRows : boolean;

sheetIndexes

Represents the indexes of exported sheets.

sheetIndexes : number[];

schemas

The original json schema of each worksheet.

schemas : string[];

exportArea

Gets or sets the exporting range.

exportArea : CellArea;

hasHeaderRow

Indicates whether the range contains header row.

hasHeaderRow : boolean;

exportAsString

Exports the string value of the cells to json.

exportAsString : boolean;

indent

Indicates the indent.

indent : string;

Remarks

If the indent is null or empty, the exported json is not formatted.

exportNestedStructure

Exported as parent-child hierarchy Json structure.

exportNestedStructure : boolean;

exportEmptyCells

Indicates whether exporting empty cells as null.

exportEmptyCells : boolean;

alwaysExportAsJsonObject

Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.

alwaysExportAsJsonObject : boolean;

toExcelStruct

Indicates whether converting to json struct of the Excel file.

toExcelStruct : boolean;

Remarks

Only for converting range to JSON.

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.

getExportStylePool()

@deprecated. Please use the ’exportStylePool’ property instead. Indicates whether to export styles collectively or individually to each cell.

getExportStylePool() : boolean;

setExportStylePool(boolean)

@deprecated. Please use the ’exportStylePool’ property instead. Indicates whether to export styles collectively or individually to each cell.

setExportStylePool(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExportHyperlinkType()

@deprecated. Please use the ’exportHyperlinkType’ property instead. Represents the type of exporting hyperlink to json.

getExportHyperlinkType() : JsonExportHyperlinkType;

Returns

JsonExportHyperlinkType

Remarks

The default value is JsonExportHyperlinkType.DisplayString;

setExportHyperlinkType(JsonExportHyperlinkType)

@deprecated. Please use the ’exportHyperlinkType’ property instead. Represents the type of exporting hyperlink to json.

setExportHyperlinkType(value: JsonExportHyperlinkType) : void;

Parameters:

ParameterTypeDescription
valueJsonExportHyperlinkTypeThe value to set.

Remarks

The default value is JsonExportHyperlinkType.DisplayString;

getSkipEmptyRows()

@deprecated. Please use the ‘skipEmptyRows’ property instead. Indicates whether skipping emtpy rows.

getSkipEmptyRows() : boolean;

setSkipEmptyRows(boolean)

@deprecated. Please use the ‘skipEmptyRows’ property instead. Indicates whether skipping emtpy rows.

setSkipEmptyRows(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getSheetIndexes()

@deprecated. Please use the ‘sheetIndexes’ property instead. Represents the indexes of exported sheets.

getSheetIndexes() : number[];

Returns

number[]

setSheetIndexes(number[])

@deprecated. Please use the ‘sheetIndexes’ property instead. Represents the indexes of exported sheets.

setSheetIndexes(value: number[]) : void;

Parameters:

ParameterTypeDescription
valuenumber[]The value to set.

getSchemas()

@deprecated. Please use the ‘schemas’ property instead. The original json schema of each worksheet.

getSchemas() : string[];

Returns

string[]

setSchemas(string[])

@deprecated. Please use the ‘schemas’ property instead. The original json schema of each worksheet.

setSchemas(value: string[]) : void;

Parameters:

ParameterTypeDescription
valuestring[]The value to set.

getExportArea()

@deprecated. Please use the ’exportArea’ property instead. Gets or sets the exporting range.

getExportArea() : CellArea;

Returns

CellArea

setExportArea(CellArea)

@deprecated. Please use the ’exportArea’ property instead. Gets or sets the exporting range.

setExportArea(value: CellArea) : void;

Parameters:

ParameterTypeDescription
valueCellAreaThe value to set.

getHasHeaderRow()

@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.

getHasHeaderRow() : boolean;

setHasHeaderRow(boolean)

@deprecated. Please use the ‘hasHeaderRow’ property instead. Indicates whether the range contains header row.

setHasHeaderRow(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExportAsString()

@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.

getExportAsString() : boolean;

setExportAsString(boolean)

@deprecated. Please use the ’exportAsString’ property instead. Exports the string value of the cells to json.

setExportAsString(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getIndent()

@deprecated. Please use the ‘indent’ property instead. Indicates the indent.

getIndent() : string;

Remarks

If the indent is null or empty, the exported json is not formatted.

setIndent(string)

@deprecated. Please use the ‘indent’ property instead. Indicates the indent.

setIndent(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

If the indent is null or empty, the exported json is not formatted.

getExportNestedStructure()

@deprecated. Please use the ’exportNestedStructure’ property instead. Exported as parent-child hierarchy Json structure.

getExportNestedStructure() : boolean;

setExportNestedStructure(boolean)

@deprecated. Please use the ’exportNestedStructure’ property instead. Exported as parent-child hierarchy Json structure.

setExportNestedStructure(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getExportEmptyCells()

@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.

getExportEmptyCells() : boolean;

setExportEmptyCells(boolean)

@deprecated. Please use the ’exportEmptyCells’ property instead. Indicates whether exporting empty cells as null.

setExportEmptyCells(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAlwaysExportAsJsonObject()

@deprecated. Please use the ‘alwaysExportAsJsonObject’ property instead. Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.

getAlwaysExportAsJsonObject() : boolean;

setAlwaysExportAsJsonObject(boolean)

@deprecated. Please use the ‘alwaysExportAsJsonObject’ property instead. Indicates whether always exporting excel to json as object, even there is only a worksheet in the file.

setAlwaysExportAsJsonObject(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getToExcelStruct()

@deprecated. Please use the ’toExcelStruct’ property instead. Indicates whether converting to json struct of the Excel file.

getToExcelStruct() : boolean;

Remarks

Only for converting range to JSON.

setToExcelStruct(boolean)

@deprecated. Please use the ’toExcelStruct’ property instead. Indicates whether converting to json struct of the Excel file.

setToExcelStruct(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

Only for converting range to JSON.

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.