Methods

getAutoFilter()

Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

getAutoFitterOptions()

Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.

getCheckDataValid()

Check whether data is valid in the template file.

getCheckExcelRestriction()

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K 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.

getConvertDateTimeData()

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

getConvertNumericData()

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

getEncoding()

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

getFontConfigs()

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

getIgnoreNotPrinted()

Ignore the data which are not printed if directly printing the file Only for xlsx file.

getInterruptMonitor()

Gets and sets the interrupt monitor.

getKeepPrecision()

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

getKeepUnparsedData()

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. 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,

getLanguageCode()

Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.

getLightCellsDataHandler()

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

getLoadFilter()

The filter to denote how to load data.

getLoadFormat()

Gets the load format. The value of the property is LoadFormat integer constant.

getLoadStyleStrategy()

Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.

getLocale()

Gets and sets the Locale used for workbook at the time the file was loaded.

getMemorySetting()

Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.

getParsingFormulaOnOpen()

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

getParsingPivotCachedRecords()

Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

getPassword()

Gets and set the password of the workbook.

getRegion()

Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file, please reset it after reading the file.

getStandardFont()

Sets the default standard font name

getStandardFontSize()

Sets the default standard font size.

getWarningCallback()

Gets or sets warning callback.

setAutoFilter()

Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

setAutoFitterOptions()

Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.

setCheckDataValid()

Check whether data is valid in the template file.

setCheckExcelRestriction()

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.

setConvertDateTimeData()

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

setConvertNumericData()

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

setEncoding()

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

setFontConfigs()

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

setIgnoreNotPrinted()

Ignore the data which are not printed if directly printing the file Only for xlsx file.

setInterruptMonitor()

Gets and sets the interrupt monitor.

setKeepPrecision()

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

setKeepUnparsedData()

Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. 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,

setLanguageCode()

Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.

setLightCellsDataHandler()

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

setLoadFilter()

The filter to denote how to load data.

setLoadStyleStrategy()

Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.

setLocale()

Gets and sets the Locale used for workbook at the time the file was loaded.

setMemorySetting()

Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.

setPaperSize(type)

Sets the default print paper size from default printer's setting. If there is no setting about paper size,MS Excel will use default printer's setting.

Parameter

Name Type Optional Description

type

Number

 

PaperSizeType

setParsingFormulaOnOpen()

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

setParsingPivotCachedRecords()

Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

setPassword()

Gets and set the password of the workbook.

setRegion()

Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file, please reset it after reading the file.

setStandardFont()

Sets the default standard font name

setStandardFontSize()

Sets the default standard font size.

setWarningCallback()

Gets or sets warning callback.