aspose.cells
Class LoadFilter

Represents the filter that provides options for loading data when loading workbook from template. User may specify the filter options or implement their own LoadFilter to specify how to load data.

Constructor Summary
LoadFilter()
           Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.
LoadFilter(opts)
           Constructs one LoadFilter with given filter options.
 
Property Getters/Setters Summary
functiongetLoadDataFilterOptions()
functionsetLoadDataFilterOptions(value)
           The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant.
 
Method Summary
functionstartSheet(sheet)
           Prepares 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.
 

Constructor Detail

LoadFilter

function LoadFilter()
Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.

LoadFilter

function LoadFilter(opts)
Constructs one LoadFilter with given filter options.
Parameters:
opts: Number - A LoadDataFilterOptions value. the default filter options

Property Getters/Setters Detail

getLoadDataFilterOptions/setLoadDataFilterOptions : Number 

function getLoadDataFilterOptions() / function setLoadDataFilterOptions(value)
The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant.

Method Detail

startSheet

function startSheet(sheet)
Prepares 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.
Parameters:
sheet: Worksheet - The worksheet to be loaded. There are only few properties can be used for the given worksheet object here because most data and properties have not been loaded. The available properties are: Name, Index, VisibilityType

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.