LoadOptions class

LoadOptions class

Represents the options of loading the file.

The LoadOptions type exposes the following members:

Constructors

ConstructorDescription
initCreates an options of loading the file.
initCreates an options of loading the file.

Properties

PropertyDescription
load_formatGets the load format.
passwordGets and set the password of the workbook.
parsing_formula_on_openIndicates whether parsing the formula when reading the file.
parsing_pivot_cached_recordsIndicates whether parsing pivot cached records when loading the file.
The default value is false.
language_codeGets or sets the user interface language of the Workbook version based on CountryCode that has saved the file.
regionGets or sets the system regional settings based on CountryCode at the time the file was loaded.
default_style_settingsGets the default style settings for initializing styles of the workbook
standard_fontSets the default standard font name
standard_font_sizeSets the default standard font size.
interrupt_monitorGets and sets the interrupt monitor.
ignore_not_printedIgnore the data which are not printed if directly printing the file
check_data_validCheck whether data is valid in the template file.
check_excel_restrictionWhether 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.
keep_unparsed_dataWhether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
load_filterThe filter to denote how to load data.
light_cells_data_handlerThe data handler for processing cells data when reading template file.
memory_settingGets or sets the memory usage options.
warning_callbackGets or sets warning callback.
auto_fitter_optionsGets and sets the auto fitter options
auto_filterIndicates whether auto filtering the data when loading the files.
font_configsGets and sets individual font configs.
Only works for the Workbook which uses this LoadOptions to load.
ignore_useless_shapesIndicates whether ignoring useless shapes.
preserve_padding_spaces_in_formulaIndicates whether preserve those spaces and line breaks that are padded between formula tokens
while getting and setting formulas.
Default value is false.

Methods

MethodDescription
set_paper_sizeSets the default print paper size from default printer’s setting.

See Also

LoadFilter class MarkdownSaveOptions class