LoadFilter Class

Represents the filter that provides options for loading data when loading workbook from template.
Inheritance Hierarchy
SystemObject
  Aspose.CellsLoadFilter

Namespace:  Aspose.Cells
Assembly:  Aspose.Cells (in Aspose.Cells.dll) Version: 20.6.0.0 (20.6)
Syntax
public class LoadFilter

The LoadFilter type exposes the following members.

Constructors
  NameDescription
Public methodLoadFilter
Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.
Public methodLoadFilter(LoadDataFilterOptions)
Constructs one LoadFilter with given filter options.
Properties
  NameDescription
Public propertyLoadDataFilterOptions
The filter options to denote what data should be loaded.
Public propertySheetsInLoadingOrder
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.
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodStartSheet
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.
Public methodToString (Inherited from Object.)
Remarks
User may specify the filter options or implement their own LoadFilter to specify how to load data.
Examples
The following example shows how to determine the filter options according to worksheet's properties.
[C#]
Workbook wb = new Workbook(template, new LoadOptions() { LoadFilter = new LoadFilterSheet() });
//Custom LoadFilter implementation
class LoadFilterSheet : LoadFilter
{
    public override void StartSheet(Worksheet sheet) 
    {
        if (sheet.Name == "Sheet1")
        {
            LoadDataFilterOptions = Aspose.Cells.LoadDataFilterOptions.All;
        }
        else
        {
            LoadDataFilterOptions = Aspose.Cells.LoadDataFilterOptions.None;
        }
    }
}
See Also