EbookLoadOptions

EbookLoadOptions class

Represents options when importing an ebook file.

class EbookLoadOptions extends HtmlLoadOptions;

Constructors

Constructor	Description
constructor()	Creates an options of loading the ebook file.
constructor(HtmlLoadOptions)	Constructs from a parent object convertible to this.
constructor(LoadFormat)	Creates an options of loading the ebook file.

Properties

Property	Type	Description
loadFormat	LoadFormat	Readonly. Gets the load format.
password	string	Gets and set the password of the workbook.
parsingFormulaOnOpen	boolean	Indicates whether parsing the formula when reading the file.
parsingPivotCachedRecords	boolean	Indicates whether parsing pivot cached records when loading the file. The default value is false.
languageCode	CountryCode	Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
region	CountryCode	Gets or sets the regional settings used for the Workbook that will be loaded.
defaultStyleSettings	DefaultStyleSettings	Readonly. Gets the default style settings for initializing styles of the workbook
interruptMonitor	AbstractInterruptMonitor	Gets and sets the interrupt monitor.
ignoreNotPrinted	boolean	Ignore the data which are not printed if directly printing the file
checkDataValid	boolean	Check whether data is valid in the template file.
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 such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.
keepUnparsedData	boolean	Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
loadFilter	LoadFilter	The filter to denote how to load data.
lightCellsDataHandler	LightCellsDataHandler	The data handler for processing cells data when reading template file.
memorySetting	MemorySetting	Gets or sets the memory usage options.
warningCallback	IWarningCallback	Gets or sets warning callback.
autoFitterOptions	AutoFitterOptions	Gets and sets the auto fitter options
autoFilter	boolean	Indicates whether auto filtering the data when loading the files.
fontConfigs	IndividualFontConfigs	Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
ignoreUselessShapes	boolean	Indicates whether ignoring useless shapes.
preservePaddingSpacesInFormula	boolean	Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
encoding	EncodingType	Gets and sets the default encoding. Only applies for csv file.
loadStyleStrategy	TxtLoadStyleStrategy	Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
convertNumericData	boolean	Gets or sets a value that indicates whether the string in text file is converted to numeric data.
convertDateTimeData	boolean	Gets or sets a value that indicates whether the string in text file is converted to date data.
keepPrecision	boolean	Indicates whether not parsing a string value if the length is 15.
loadFormulas	boolean	Indicates whether importing formulas if the original html file contains formulas
supportDivTag	boolean	Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.
deleteRedundantSpaces	boolean	Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.
autoFitColsAndRows	boolean	Indicates whether auto-fit columns and rows. The default value is false.
hasFormula	boolean	Indicates whether the text is formula if it starts with “=”.
progId	string	Readonly. Gets the program id of creating the file. Only for MHT files.
tableLoadOptions	HtmlTableLoadOptionCollection	Readonly. Get the HtmlTableLoadOptionCollection instance

Methods

Method	Description
isNull()	Checks whether the implementation object is null.
getLoadFormat()	@deprecated. Please use the ’loadFormat’ property instead. Gets the load format.
getPassword()	@deprecated. Please use the ‘password’ property instead. Gets and set the password of the workbook.
setPassword(string)	@deprecated. Please use the ‘password’ property instead. Gets and set the password of the workbook.
getParsingFormulaOnOpen()	@deprecated. Please use the ‘parsingFormulaOnOpen’ property instead. Indicates whether parsing the formula when reading the file.
setParsingFormulaOnOpen(boolean)	@deprecated. Please use the ‘parsingFormulaOnOpen’ property instead. Indicates whether parsing the formula when reading the file.
getParsingPivotCachedRecords()	@deprecated. Please use the ‘parsingPivotCachedRecords’ property instead. Indicates whether parsing pivot cached records when loading the file. The default value is false.
setParsingPivotCachedRecords(boolean)	@deprecated. Please use the ‘parsingPivotCachedRecords’ property instead. Indicates whether parsing pivot cached records when loading the file. The default value is false.
getLanguageCode()	@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
setLanguageCode(CountryCode)	@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
getRegion()	@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings used for the Workbook that will be loaded.
setRegion(CountryCode)	@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings used for the Workbook that will be loaded.
getDefaultStyleSettings()	@deprecated. Please use the ‘defaultStyleSettings’ property instead. Gets the default style settings for initializing styles of the workbook
getInterruptMonitor()	@deprecated. Please use the ‘interruptMonitor’ property instead. Gets and sets the interrupt monitor.
setInterruptMonitor(AbstractInterruptMonitor)	@deprecated. Please use the ‘interruptMonitor’ property instead. Gets and sets the interrupt monitor.
getIgnoreNotPrinted()	@deprecated. Please use the ‘ignoreNotPrinted’ property instead. Ignore the data which are not printed if directly printing the file
setIgnoreNotPrinted(boolean)	@deprecated. Please use the ‘ignoreNotPrinted’ property instead. Ignore the data which are not printed if directly printing the file
getCheckDataValid()	@deprecated. Please use the ‘checkDataValid’ property instead. Check whether data is valid in the template file.
setCheckDataValid(boolean)	@deprecated. Please use the ‘checkDataValid’ property instead. Check whether data is valid in the template file.
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 such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.
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 such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.
getKeepUnparsedData()	@deprecated. Please use the ‘keepUnparsedData’ property instead. Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
setKeepUnparsedData(boolean)	@deprecated. Please use the ‘keepUnparsedData’ property instead. Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
getLoadFilter()	@deprecated. Please use the ’loadFilter’ property instead. The filter to denote how to load data.
setLoadFilter(LoadFilter)	@deprecated. Please use the ’loadFilter’ property instead. The filter to denote how to load data.
getLightCellsDataHandler()	@deprecated. Please use the ’lightCellsDataHandler’ property instead. The data handler for processing cells data when reading template file.
setLightCellsDataHandler(LightCellsDataHandler)	@deprecated. Please use the ’lightCellsDataHandler’ property instead. The data handler for processing cells data when reading template file.
getMemorySetting()	@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options.
setMemorySetting(MemorySetting)	@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options.
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.
getAutoFitterOptions()	@deprecated. Please use the ‘autoFitterOptions’ property instead. Gets and sets the auto fitter options
setAutoFitterOptions(AutoFitterOptions)	@deprecated. Please use the ‘autoFitterOptions’ property instead. Gets and sets the auto fitter options
getAutoFilter()	@deprecated. Please use the ‘autoFilter’ property instead. Indicates whether auto filtering the data when loading the files.
setAutoFilter(boolean)	@deprecated. Please use the ‘autoFilter’ property instead. Indicates whether auto filtering the data when loading the files.
getFontConfigs()	@deprecated. Please use the ‘fontConfigs’ property instead. Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
setFontConfigs(IndividualFontConfigs)	@deprecated. Please use the ‘fontConfigs’ property instead. Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.
getIgnoreUselessShapes()	@deprecated. Please use the ‘ignoreUselessShapes’ property instead. Indicates whether ignoring useless shapes.
setIgnoreUselessShapes(boolean)	@deprecated. Please use the ‘ignoreUselessShapes’ property instead. Indicates whether ignoring useless shapes.
getPreservePaddingSpacesInFormula()	@deprecated. Please use the ‘preservePaddingSpacesInFormula’ property instead. Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
setPreservePaddingSpacesInFormula(boolean)	@deprecated. Please use the ‘preservePaddingSpacesInFormula’ property instead. Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
setPaperSize(PaperSizeType)	Sets the default print paper size from default printer’s setting.
getEncoding()	@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding. Only applies for csv file.
setEncoding(EncodingType)	@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding. Only applies for csv file.
getLoadStyleStrategy()	@deprecated. Please use the ’loadStyleStrategy’ property instead. Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
setLoadStyleStrategy(TxtLoadStyleStrategy)	@deprecated. Please use the ’loadStyleStrategy’ property instead. Indicates the strategy to apply style for parsed values when converting string value to number or datetime.
getConvertNumericData()	@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to numeric data.
setConvertNumericData(boolean)	@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to numeric data.
getConvertDateTimeData()	@deprecated. Please use the ‘convertDateTimeData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to date data.
setConvertDateTimeData(boolean)	@deprecated. Please use the ‘convertDateTimeData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to date data.
getKeepPrecision()	@deprecated. Please use the ‘keepPrecision’ property instead. Indicates whether not parsing a string value if the length is 15.
setKeepPrecision(boolean)	@deprecated. Please use the ‘keepPrecision’ property instead. Indicates whether not parsing a string value if the length is 15.
getLoadFormulas()	@deprecated. Please use the ’loadFormulas’ property instead. Indicates whether importing formulas if the original html file contains formulas
setLoadFormulas(boolean)	@deprecated. Please use the ’loadFormulas’ property instead. Indicates whether importing formulas if the original html file contains formulas
getSupportDivTag()	@deprecated. Please use the ‘supportDivTag’ property instead. Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.
setSupportDivTag(boolean)	@deprecated. Please use the ‘supportDivTag’ property instead. Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.
getDeleteRedundantSpaces()	@deprecated. Please use the ‘deleteRedundantSpaces’ property instead. Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.
setDeleteRedundantSpaces(boolean)	@deprecated. Please use the ‘deleteRedundantSpaces’ property instead. Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.
getAutoFitColsAndRows()	@deprecated. Please use the ‘autoFitColsAndRows’ property instead. Indicates whether auto-fit columns and rows. The default value is false.
setAutoFitColsAndRows(boolean)	@deprecated. Please use the ‘autoFitColsAndRows’ property instead. Indicates whether auto-fit columns and rows. The default value is false.
getHasFormula()	@deprecated. Please use the ‘hasFormula’ property instead. Indicates whether the text is formula if it starts with “=”.
setHasFormula(boolean)	@deprecated. Please use the ‘hasFormula’ property instead. Indicates whether the text is formula if it starts with “=”.
getProgId()	@deprecated. Please use the ‘progId’ property instead. Gets the program id of creating the file. Only for MHT files.
getTableLoadOptions()	@deprecated. Please use the ’tableLoadOptions’ property instead. Get the HtmlTableLoadOptionCollection instance

constructor()

Creates an options of loading the ebook file.

constructor();

constructor(HtmlLoadOptions)

Constructs from a parent object convertible to this.

constructor(obj: HtmlLoadOptions);

Parameters:

Parameter	Type	Description
obj	HtmlLoadOptions	The parent object.

constructor(LoadFormat)

Creates an options of loading the ebook file.

constructor(loadFormat: LoadFormat);

Parameters:

Parameter	Type	Description
loadFormat	LoadFormat	The loading format

loadFormat

Readonly. Gets the load format.

loadFormat : LoadFormat;

password

Gets and set the password of the workbook.

password : string;

parsingFormulaOnOpen

Indicates whether parsing the formula when reading the file.

parsingFormulaOnOpen : boolean;

Remarks

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

parsingPivotCachedRecords

Indicates whether parsing pivot cached records when loading the file. The default value is false.

parsingPivotCachedRecords : boolean;

Remarks

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

languageCode

Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

languageCode : CountryCode;

region

Gets or sets the regional settings used for the Workbook that will be loaded.

region : CountryCode;

Remarks

The regional settings may be used for initializing some features for the workbook such as fonts, themes, and so on. For text based file formats, such as CSV, HTML, …, the regional setting also will be used to detect number formats and parse text values to numeric or datetime values for cells. This setting will be kept for the instantiated workbook later, that is, WorkbookSettings.Region of the workbook will use the same region with this property.

defaultStyleSettings

Readonly. Gets the default style settings for initializing styles of the workbook

defaultStyleSettings : DefaultStyleSettings;

interruptMonitor

Gets and sets the interrupt monitor.

interruptMonitor : AbstractInterruptMonitor;

ignoreNotPrinted

Ignore the data which are not printed if directly printing the file

ignoreNotPrinted : boolean;

Remarks

Only for xlsx file.

checkDataValid

Check whether data is valid in the template file.

checkDataValid : boolean;

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 such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

checkExcelRestriction : boolean;

keepUnparsedData

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

keepUnparsedData : boolean;

Remarks

For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,

loadFilter

The filter to denote how to load data.

loadFilter : LoadFilter;

lightCellsDataHandler

The data handler for processing cells data when reading template file.

lightCellsDataHandler : LightCellsDataHandler;

memorySetting

Gets or sets the memory usage options.

memorySetting : MemorySetting;

warningCallback

Gets or sets warning callback.

warningCallback : IWarningCallback;

autoFitterOptions

Gets and sets the auto fitter options

autoFitterOptions : AutoFitterOptions;

Remarks

Only for xlsx ,spreadsheetML file now.

autoFilter

Indicates whether auto filtering the data when loading the files.

autoFilter : boolean;

Remarks

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

fontConfigs

Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.

fontConfigs : IndividualFontConfigs;

ignoreUselessShapes

Indicates whether ignoring useless shapes.

ignoreUselessShapes : boolean;

Remarks

Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.

preservePaddingSpacesInFormula

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

preservePaddingSpacesInFormula : boolean;

Remarks

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.

encoding

Gets and sets the default encoding. Only applies for csv file.

encoding : EncodingType;

loadStyleStrategy

Indicates the strategy to apply style for parsed values when converting string value to number or datetime.

loadStyleStrategy : TxtLoadStyleStrategy;

convertNumericData

Gets or sets a value that indicates whether the string in text file is converted to numeric data.

convertNumericData : boolean;

convertDateTimeData

Gets or sets a value that indicates whether the string in text file is converted to date data.

convertDateTimeData : boolean;

keepPrecision

Indicates whether not parsing a string value if the length is 15.

keepPrecision : boolean;

loadFormulas

Indicates whether importing formulas if the original html file contains formulas

loadFormulas : boolean;

supportDivTag

Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.

supportDivTag : boolean;

deleteRedundantSpaces

Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.

deleteRedundantSpaces : boolean;

autoFitColsAndRows

Indicates whether auto-fit columns and rows. The default value is false.

autoFitColsAndRows : boolean;

hasFormula

Indicates whether the text is formula if it starts with “=”.

hasFormula : boolean;

progId

Readonly. Gets the program id of creating the file. Only for MHT files.

progId : string;

tableLoadOptions

Readonly. Get the HtmlTableLoadOptionCollection instance

tableLoadOptions : HtmlTableLoadOptionCollection;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getLoadFormat()

@deprecated. Please use the ’loadFormat’ property instead. Gets the load format.

getLoadFormat() : LoadFormat;

Returns

LoadFormat

getPassword()

@deprecated. Please use the ‘password’ property instead. Gets and set the password of the workbook.

getPassword() : string;

setPassword(string)

@deprecated. Please use the ‘password’ property instead. Gets and set the password of the workbook.

setPassword(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getParsingFormulaOnOpen()

@deprecated. Please use the ‘parsingFormulaOnOpen’ property instead. Indicates whether parsing the formula when reading the file.

getParsingFormulaOnOpen() : boolean;

Remarks

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

setParsingFormulaOnOpen(boolean)

@deprecated. Please use the ‘parsingFormulaOnOpen’ property instead. Indicates whether parsing the formula when reading the file.

setParsingFormulaOnOpen(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

getParsingPivotCachedRecords()

@deprecated. Please use the ‘parsingPivotCachedRecords’ property instead. Indicates whether parsing pivot cached records when loading the file. The default value is false.

getParsingPivotCachedRecords() : boolean;

Remarks

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

setParsingPivotCachedRecords(boolean)

@deprecated. Please use the ‘parsingPivotCachedRecords’ property instead. Indicates whether parsing pivot cached records when loading the file. The default value is false.

setParsingPivotCachedRecords(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

getLanguageCode()

@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

getLanguageCode() : CountryCode;

Returns

CountryCode

setLanguageCode(CountryCode)

@deprecated. Please use the ’languageCode’ property instead. Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.

setLanguageCode(value: CountryCode) : void;

Parameters:

Parameter	Type	Description
value	CountryCode	The value to set.

getRegion()

@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings used for the Workbook that will be loaded.

getRegion() : CountryCode;

Returns

CountryCode

Remarks

setRegion(CountryCode)

@deprecated. Please use the ‘region’ property instead. Gets or sets the regional settings used for the Workbook that will be loaded.

setRegion(value: CountryCode) : void;

Parameters:

Parameter	Type	Description
value	CountryCode	The value to set.

Remarks

getDefaultStyleSettings()

@deprecated. Please use the ‘defaultStyleSettings’ property instead. Gets the default style settings for initializing styles of the workbook

getDefaultStyleSettings() : DefaultStyleSettings;

Returns

DefaultStyleSettings

getInterruptMonitor()

@deprecated. Please use the ‘interruptMonitor’ property instead. Gets and sets the interrupt monitor.

getInterruptMonitor() : AbstractInterruptMonitor;

Returns

AbstractInterruptMonitor

setInterruptMonitor(AbstractInterruptMonitor)

@deprecated. Please use the ‘interruptMonitor’ property instead. Gets and sets the interrupt monitor.

setInterruptMonitor(value: AbstractInterruptMonitor) : void;

Parameters:

Parameter	Type	Description
value	AbstractInterruptMonitor	The value to set.

getIgnoreNotPrinted()

@deprecated. Please use the ‘ignoreNotPrinted’ property instead. Ignore the data which are not printed if directly printing the file

getIgnoreNotPrinted() : boolean;

Remarks

Only for xlsx file.

setIgnoreNotPrinted(boolean)

@deprecated. Please use the ‘ignoreNotPrinted’ property instead. Ignore the data which are not printed if directly printing the file

setIgnoreNotPrinted(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for xlsx file.

getCheckDataValid()

@deprecated. Please use the ‘checkDataValid’ property instead. Check whether data is valid in the template file.

getCheckDataValid() : boolean;

setCheckDataValid(boolean)

@deprecated. Please use the ‘checkDataValid’ property instead. Check whether data is valid in the template file.

setCheckDataValid(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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 such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

getCheckExcelRestriction() : boolean;

setCheckExcelRestriction(boolean)

setCheckExcelRestriction(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getKeepUnparsedData()

@deprecated. Please use the ‘keepUnparsedData’ property instead. Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

getKeepUnparsedData() : boolean;

Remarks

setKeepUnparsedData(boolean)

@deprecated. Please use the ‘keepUnparsedData’ property instead. Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.

setKeepUnparsedData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getLoadFilter()

@deprecated. Please use the ’loadFilter’ property instead. The filter to denote how to load data.

getLoadFilter() : LoadFilter;

Returns

LoadFilter

setLoadFilter(LoadFilter)

@deprecated. Please use the ’loadFilter’ property instead. The filter to denote how to load data.

setLoadFilter(value: LoadFilter) : void;

Parameters:

Parameter	Type	Description
value	LoadFilter	The value to set.

getLightCellsDataHandler()

@deprecated. Please use the ’lightCellsDataHandler’ property instead. The data handler for processing cells data when reading template file.

getLightCellsDataHandler() : LightCellsDataHandler;

Returns

LightCellsDataHandler

setLightCellsDataHandler(LightCellsDataHandler)

@deprecated. Please use the ’lightCellsDataHandler’ property instead. The data handler for processing cells data when reading template file.

setLightCellsDataHandler(value: LightCellsDataHandler) : void;

Parameters:

Parameter	Type	Description
value	LightCellsDataHandler	The value to set.

getMemorySetting()

@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options.

getMemorySetting() : MemorySetting;

Returns

MemorySetting

setMemorySetting(MemorySetting)

@deprecated. Please use the ‘memorySetting’ property instead. Gets or sets the memory usage options.

setMemorySetting(value: MemorySetting) : void;

Parameters:

Parameter	Type	Description
value	MemorySetting	The value to set.

setWarningCallback(IWarningCallback)

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

setWarningCallback(value: IWarningCallback) : void;

Parameters:

Parameter	Type	Description
value	IWarningCallback	The value to set.

getWarningCallback()

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

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

getAutoFitterOptions()

@deprecated. Please use the ‘autoFitterOptions’ property instead. Gets and sets the auto fitter options

getAutoFitterOptions() : AutoFitterOptions;

Returns

AutoFitterOptions

Remarks

Only for xlsx ,spreadsheetML file now.

setAutoFitterOptions(AutoFitterOptions)

@deprecated. Please use the ‘autoFitterOptions’ property instead. Gets and sets the auto fitter options

setAutoFitterOptions(value: AutoFitterOptions) : void;

Parameters:

Parameter	Type	Description
value	AutoFitterOptions	The value to set.

Remarks

Only for xlsx ,spreadsheetML file now.

getAutoFilter()

@deprecated. Please use the ‘autoFilter’ property instead. Indicates whether auto filtering the data when loading the files.

getAutoFilter() : boolean;

Remarks

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

setAutoFilter(boolean)

@deprecated. Please use the ‘autoFilter’ property instead. Indicates whether auto filtering the data when loading the files.

setAutoFilter(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

getFontConfigs()

@deprecated. Please use the ‘fontConfigs’ property instead. Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.

getFontConfigs() : IndividualFontConfigs;

Returns

IndividualFontConfigs

setFontConfigs(IndividualFontConfigs)

@deprecated. Please use the ‘fontConfigs’ property instead. Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.

setFontConfigs(value: IndividualFontConfigs) : void;

Parameters:

Parameter	Type	Description
value	IndividualFontConfigs	The value to set.

getIgnoreUselessShapes()

@deprecated. Please use the ‘ignoreUselessShapes’ property instead. Indicates whether ignoring useless shapes.

getIgnoreUselessShapes() : boolean;

Remarks

Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.

setIgnoreUselessShapes(boolean)

@deprecated. Please use the ‘ignoreUselessShapes’ property instead. Indicates whether ignoring useless shapes.

setIgnoreUselessShapes(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only works for xlsx,xlsb, and xlsm files. There are many overlapping identical shapes which are useless in some files, we can ingore them when loading files.

getPreservePaddingSpacesInFormula()

@deprecated. Please use the ‘preservePaddingSpacesInFormula’ property instead. Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

getPreservePaddingSpacesInFormula() : boolean;

Remarks

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.

setPreservePaddingSpacesInFormula(boolean)

setPreservePaddingSpacesInFormula(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

After loading workbook from template file with this option, FormulaSettings.PreservePaddingSpaces will be set to the same value with this property.

setPaperSize(PaperSizeType)

Sets the default print paper size from default printer’s setting.

setPaperSize(type: PaperSizeType) : void;

Parameters:

Parameter	Type	Description
type	PaperSizeType	The default paper size.

Remarks

If there is no setting about paper size,MS Excel will use default printer’s setting.

getEncoding()

@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding. Only applies for csv file.

getEncoding() : EncodingType;

Returns

EncodingType

setEncoding(EncodingType)

@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding. Only applies for csv file.

setEncoding(value: EncodingType) : void;

Parameters:

Parameter	Type	Description
value	EncodingType	The value to set.

getLoadStyleStrategy()

@deprecated. Please use the ’loadStyleStrategy’ property instead. Indicates the strategy to apply style for parsed values when converting string value to number or datetime.

getLoadStyleStrategy() : TxtLoadStyleStrategy;

Returns

TxtLoadStyleStrategy

setLoadStyleStrategy(TxtLoadStyleStrategy)

@deprecated. Please use the ’loadStyleStrategy’ property instead. Indicates the strategy to apply style for parsed values when converting string value to number or datetime.

setLoadStyleStrategy(value: TxtLoadStyleStrategy) : void;

Parameters:

Parameter	Type	Description
value	TxtLoadStyleStrategy	The value to set.

getConvertNumericData()

@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to numeric data.

getConvertNumericData() : boolean;

setConvertNumericData(boolean)

@deprecated. Please use the ‘convertNumericData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to numeric data.

setConvertNumericData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getConvertDateTimeData()

@deprecated. Please use the ‘convertDateTimeData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to date data.

getConvertDateTimeData() : boolean;

setConvertDateTimeData(boolean)

@deprecated. Please use the ‘convertDateTimeData’ property instead. Gets or sets a value that indicates whether the string in text file is converted to date data.

setConvertDateTimeData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getKeepPrecision()

@deprecated. Please use the ‘keepPrecision’ property instead. Indicates whether not parsing a string value if the length is 15.

getKeepPrecision() : boolean;

setKeepPrecision(boolean)

@deprecated. Please use the ‘keepPrecision’ property instead. Indicates whether not parsing a string value if the length is 15.

setKeepPrecision(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLoadFormulas()

@deprecated. Please use the ’loadFormulas’ property instead. Indicates whether importing formulas if the original html file contains formulas

getLoadFormulas() : boolean;

setLoadFormulas(boolean)

@deprecated. Please use the ’loadFormulas’ property instead. Indicates whether importing formulas if the original html file contains formulas

setLoadFormulas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSupportDivTag()

@deprecated. Please use the ‘supportDivTag’ property instead. Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.

getSupportDivTag() : boolean;

setSupportDivTag(boolean)

@deprecated. Please use the ‘supportDivTag’ property instead. Indicates whether support the layout of <div> tag when the html file contains it. The default value is false.

setSupportDivTag(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getDeleteRedundantSpaces()

@deprecated. Please use the ‘deleteRedundantSpaces’ property instead. Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.

getDeleteRedundantSpaces() : boolean;

setDeleteRedundantSpaces(boolean)

@deprecated. Please use the ‘deleteRedundantSpaces’ property instead. Indicates whether delete redundant spaces when the text wraps lines using <br> tag. The default value is false.

setDeleteRedundantSpaces(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAutoFitColsAndRows()

@deprecated. Please use the ‘autoFitColsAndRows’ property instead. Indicates whether auto-fit columns and rows. The default value is false.

getAutoFitColsAndRows() : boolean;

setAutoFitColsAndRows(boolean)

@deprecated. Please use the ‘autoFitColsAndRows’ property instead. Indicates whether auto-fit columns and rows. The default value is false.

setAutoFitColsAndRows(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getHasFormula()

@deprecated. Please use the ‘hasFormula’ property instead. Indicates whether the text is formula if it starts with “=”.

getHasFormula() : boolean;

setHasFormula(boolean)

@deprecated. Please use the ‘hasFormula’ property instead. Indicates whether the text is formula if it starts with “=”.

setHasFormula(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getProgId()

@deprecated. Please use the ‘progId’ property instead. Gets the program id of creating the file. Only for MHT files.

getProgId() : string;

getTableLoadOptions()

@deprecated. Please use the ’tableLoadOptions’ property instead. Get the HtmlTableLoadOptionCollection instance

getTableLoadOptions() : HtmlTableLoadOptionCollection;

Returns

HtmlTableLoadOptionCollection