java.lang.Object
com.aspose.cells.LoadFilter
public class LoadFilter
- extends java.lang.Object
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(int opts)
Constructs one LoadFilter with given filter options.
|
|
Property Getters/Setters Summary |
int | getLoadDataFilterOptions() | |
void | setLoadDataFilterOptions(int) | |
|
The filter options to denote what data should be loaded.
The value of the property is LoadDataFilterOptions integer constant. |
int[] | getSheetsInLoadingOrder() | |
|
Specifies 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.
|
|
Method Summary |
void | startSheet(Worksheet 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.
|
LoadFilter
public LoadFilter()
-
Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.
LoadFilter
public LoadFilter(int opts)
-
Constructs one LoadFilter with given filter options.
- Parameters:
opts - A LoadDataFilterOptions value. the default filter options
|
Property Getters/Setters Detail |
getLoadDataFilterOptions/setLoadDataFilterOptions | |
public int getLoadDataFilterOptions() / public void setLoadDataFilterOptions(int value)
|
-
The filter options to denote what data should be loaded.
The value of the property is LoadDataFilterOptions integer constant.
setLoadDataFilterOptions | |
public void setLoadDataFilterOptions(int value)
|
-
The filter options to denote what data should be loaded.
The value of the property is LoadDataFilterOptions integer constant.
getSheetsInLoadingOrder | |
public int[] getSheetsInLoadingOrder()
|
-
Specifies 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.
startSheet | |
public void startSheet(Worksheet 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 - 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.Cells Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.