LoadFilter Class - Aspose.Cells for .NET

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: 19.11.0.0 (19.11)

Syntax

C++

Copy

public class LoadFilter

Public Class LoadFilter

public ref class LoadFilter

type LoadFilter =  class end

The LoadFilter type exposes the following members.

Constructors

	Name	Description
	LoadFilter	Constructs one LoadFilter with default filter options LoadDataFilterOptions.All.
	LoadFilter(LoadDataFilterOptions)	Constructs one LoadFilter with given filter options.

Properties

	Name	Description
	LoadDataFilterOptions	The filter options to denote what data should be loaded.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	StartSheet	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.
	ToString	Returns a string that represents the current object. (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.

Copy

[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;
        }
    }
}

Reference

Aspose.Cells Namespace