LoadFilter class

LoadFilter class

Represents the filter that provides options for loading data when loading workbook from template.

The LoadFilter type exposes the following members:

Constructors

ConstructorDescription
initConstructs one LoadFilter with default filter options LoadDataFilterOptions.All.
initConstructs one LoadFilter with given filter options.

Properties

PropertyDescription
load_data_filter_optionsThe filter options to denote what data should be loaded.
sheets_in_loading_orderSpecifies the sheets(indices) and order to be loaded.
Default is null, that denotes to load all sheets in the default order in template file.
If not null and some sheet’s index is not in the returned array, then the sheet will not be loaded.

Methods

MethodDescription
start_sheetPrepares filter options before loading given worksheet.
User’s implementation of LoadFilter can change the LoadDataFilterOptions here
to denote how to load data for this worksheet.

Remarks

User may specify the filter options or implement their own LoadFilter to specify how to load data.

See Also