SqlScriptSaveOptions

SqlScriptSaveOptions class

Represents the options of saving sql.

class SqlScriptSaveOptions extends SaveOptions;

Constructors

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

Properties

PropertyTypeDescription
checkIfTableExistsbooleanCheck if the table name exists before creating
columnTypeMapSqlScriptColumnTypeMapGets and sets the map of column type for different database.
checkAllDataForColumnTypebooleanCheck all data to find columns’ data type.
addBlankLineBetweenRowsbooleanInsert blank line between each data.
separatorstringGets and sets character separator of sql script.
operatorTypeSqlScriptOperatorTypeGets and sets the operator type of sql.
primaryKeynumberRepresents which column is primary key of the data table.
createTablebooleanIndicates whether exporting sql of creating table.
idNamestringGets and sets the name of id column.
startIdnumberGets and sets the start id.
tableNamestringGets and sets the table name.
exportAsStringbooleanIndicates whether exporting all data as string value.
sheetIndexesnumber[]Represents the indexes of exported sheets.
exportAreaCellAreaGets or sets the exporting range.
hasHeaderRowbooleanIndicates whether the range contains header row.
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
getCheckIfTableExists()@deprecated. Please use the ‘checkIfTableExists’ property instead. Check if the table name exists before creating
setCheckIfTableExists(boolean)@deprecated. Please use the ‘checkIfTableExists’ property instead. Check if the table name exists before creating
getColumnTypeMap()@deprecated. Please use the ‘columnTypeMap’ property instead. Gets and sets the map of column type for different database.
setColumnTypeMap(SqlScriptColumnTypeMap)@deprecated. Please use the ‘columnTypeMap’ property instead. Gets and sets the map of column type for different database.
getCheckAllDataForColumnType()@deprecated. Please use the ‘checkAllDataForColumnType’ property instead. Check all data to find columns’ data type.
setCheckAllDataForColumnType(boolean)@deprecated. Please use the ‘checkAllDataForColumnType’ property instead. Check all data to find columns’ data type.
getAddBlankLineBetweenRows()@deprecated. Please use the ‘addBlankLineBetweenRows’ property instead. Insert blank line between each data.
setAddBlankLineBetweenRows(boolean)@deprecated. Please use the ‘addBlankLineBetweenRows’ property instead. Insert blank line between each data.
getSeparator()@deprecated. Please use the ‘separator’ property instead. Gets and sets character separator of sql script.
setSeparator(string)@deprecated. Please use the ‘separator’ property instead. Gets and sets character separator of sql script.
getOperatorType()@deprecated. Please use the ‘operatorType’ property instead. Gets and sets the operator type of sql.
setOperatorType(SqlScriptOperatorType)@deprecated. Please use the ‘operatorType’ property instead. Gets and sets the operator type of sql.
getPrimaryKey()@deprecated. Please use the ‘primaryKey’ property instead. Represents which column is primary key of the data table.
setPrimaryKey(number)@deprecated. Please use the ‘primaryKey’ property instead. Represents which column is primary key of the data table.
getCreateTable()@deprecated. Please use the ‘createTable’ property instead. Indicates whether exporting sql of creating table.
setCreateTable(boolean)@deprecated. Please use the ‘createTable’ property instead. Indicates whether exporting sql of creating table.
getIdName()@deprecated. Please use the ‘idName’ property instead. Gets and sets the name of id column.
setIdName(string)@deprecated. Please use the ‘idName’ property instead. Gets and sets the name of id column.
getStartId()@deprecated. Please use the ‘startId’ property instead. Gets and sets the start id.
setStartId(number)@deprecated. Please use the ‘startId’ property instead. Gets and sets the start id.
getTableName()@deprecated. Please use the ’tableName’ property instead. Gets and sets the table name.
setTableName(string)@deprecated. Please use the ’tableName’ property instead. Gets and sets the table name.
getExportAsString()@deprecated. Please use the ’exportAsString’ property instead. Indicates whether exporting all data as string value.
setExportAsString(boolean)@deprecated. Please use the ’exportAsString’ property instead. Indicates whether exporting all data as string value.
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.
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.
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 sql file.

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

ParameterTypeDescription
objSaveOptionsThe parent object.

checkIfTableExists

Check if the table name exists before creating

checkIfTableExists : boolean;

columnTypeMap

Gets and sets the map of column type for different database.

columnTypeMap : SqlScriptColumnTypeMap;

checkAllDataForColumnType

Check all data to find columns’ data type.

checkAllDataForColumnType : boolean;

Remarks

The default value is false, we only check the first row for performance. If this property is true and the columns contains mixed value type, the columns’ type will be text.

addBlankLineBetweenRows

Insert blank line between each data.

addBlankLineBetweenRows : boolean;

Remarks

If Separator is ‘\n’ , it’s better to set this property as true to increase readability.

separator

Gets and sets character separator of sql script.

separator : string;

Remarks

Only can be ’ ’ or ‘\n’. If the

operatorType

Gets and sets the operator type of sql.

operatorType : SqlScriptOperatorType;

primaryKey

Represents which column is primary key of the data table.

primaryKey : number;

createTable

Indicates whether exporting sql of creating table.

createTable : boolean;

idName

Gets and sets the name of id column.

idName : string;

Remarks

If this property is set , a column will be inserted with automatical increment int value.

startId

Gets and sets the start id.

startId : number;

Remarks

Only works when IdName is set.

tableName

Gets and sets the table name.

tableName : string;

exportAsString

Indicates whether exporting all data as string value.

exportAsString : boolean;

sheetIndexes

Represents the indexes of exported sheets.

sheetIndexes : number[];

exportArea

Gets or sets the exporting range.

exportArea : CellArea;

hasHeaderRow

Indicates whether the range contains header row.

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

getCheckIfTableExists()

@deprecated. Please use the ‘checkIfTableExists’ property instead. Check if the table name exists before creating

getCheckIfTableExists() : boolean;

setCheckIfTableExists(boolean)

@deprecated. Please use the ‘checkIfTableExists’ property instead. Check if the table name exists before creating

setCheckIfTableExists(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getColumnTypeMap()

@deprecated. Please use the ‘columnTypeMap’ property instead. Gets and sets the map of column type for different database.

getColumnTypeMap() : SqlScriptColumnTypeMap;

Returns

SqlScriptColumnTypeMap

setColumnTypeMap(SqlScriptColumnTypeMap)

@deprecated. Please use the ‘columnTypeMap’ property instead. Gets and sets the map of column type for different database.

setColumnTypeMap(value: SqlScriptColumnTypeMap) : void;

Parameters:

ParameterTypeDescription
valueSqlScriptColumnTypeMapThe value to set.

getCheckAllDataForColumnType()

@deprecated. Please use the ‘checkAllDataForColumnType’ property instead. Check all data to find columns’ data type.

getCheckAllDataForColumnType() : boolean;

Remarks

The default value is false, we only check the first row for performance. If this property is true and the columns contains mixed value type, the columns’ type will be text.

setCheckAllDataForColumnType(boolean)

@deprecated. Please use the ‘checkAllDataForColumnType’ property instead. Check all data to find columns’ data type.

setCheckAllDataForColumnType(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

The default value is false, we only check the first row for performance. If this property is true and the columns contains mixed value type, the columns’ type will be text.

getAddBlankLineBetweenRows()

@deprecated. Please use the ‘addBlankLineBetweenRows’ property instead. Insert blank line between each data.

getAddBlankLineBetweenRows() : boolean;

Remarks

If Separator is ‘\n’ , it’s better to set this property as true to increase readability.

setAddBlankLineBetweenRows(boolean)

@deprecated. Please use the ‘addBlankLineBetweenRows’ property instead. Insert blank line between each data.

setAddBlankLineBetweenRows(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

Remarks

If Separator is ‘\n’ , it’s better to set this property as true to increase readability.

getSeparator()

@deprecated. Please use the ‘separator’ property instead. Gets and sets character separator of sql script.

getSeparator() : string;

Remarks

Only can be ’ ’ or ‘\n’. If the

setSeparator(string)

@deprecated. Please use the ‘separator’ property instead. Gets and sets character separator of sql script.

setSeparator(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

Only can be ’ ’ or ‘\n’. If the

getOperatorType()

@deprecated. Please use the ‘operatorType’ property instead. Gets and sets the operator type of sql.

getOperatorType() : SqlScriptOperatorType;

Returns

SqlScriptOperatorType

setOperatorType(SqlScriptOperatorType)

@deprecated. Please use the ‘operatorType’ property instead. Gets and sets the operator type of sql.

setOperatorType(value: SqlScriptOperatorType) : void;

Parameters:

ParameterTypeDescription
valueSqlScriptOperatorTypeThe value to set.

getPrimaryKey()

@deprecated. Please use the ‘primaryKey’ property instead. Represents which column is primary key of the data table.

getPrimaryKey() : number;

setPrimaryKey(number)

@deprecated. Please use the ‘primaryKey’ property instead. Represents which column is primary key of the data table.

setPrimaryKey(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getCreateTable()

@deprecated. Please use the ‘createTable’ property instead. Indicates whether exporting sql of creating table.

getCreateTable() : boolean;

setCreateTable(boolean)

@deprecated. Please use the ‘createTable’ property instead. Indicates whether exporting sql of creating table.

setCreateTable(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getIdName()

@deprecated. Please use the ‘idName’ property instead. Gets and sets the name of id column.

getIdName() : string;

Remarks

If this property is set , a column will be inserted with automatical increment int value.

setIdName(string)

@deprecated. Please use the ‘idName’ property instead. Gets and sets the name of id column.

setIdName(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

If this property is set , a column will be inserted with automatical increment int value.

getStartId()

@deprecated. Please use the ‘startId’ property instead. Gets and sets the start id.

getStartId() : number;

Remarks

Only works when IdName is set.

setStartId(number)

@deprecated. Please use the ‘startId’ property instead. Gets and sets the start id.

setStartId(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

Only works when IdName is set.

getTableName()

@deprecated. Please use the ’tableName’ property instead. Gets and sets the table name.

getTableName() : string;

setTableName(string)

@deprecated. Please use the ’tableName’ property instead. Gets and sets the table name.

setTableName(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getExportAsString()

@deprecated. Please use the ’exportAsString’ property instead. Indicates whether exporting all data as string value.

getExportAsString() : boolean;

setExportAsString(boolean)

@deprecated. Please use the ’exportAsString’ property instead. Indicates whether exporting all data as string value.

setExportAsString(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.

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.

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.