SheetAutoFilter.Apply(CellRange) Method

Enables the filtering functionality for the specified range of cells.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void Apply(
    CellRange range
)

VB.NET

Sub Apply(
    range As CellRange
)

Parameters

Name	Type	Description
range	CellRange	A CellRange object that is the cell range to which the filter is applied.

Remarks

Once the filter is activated, a drop-down arrow appears on the right side of each column header. End-users can click the arrow of the required column and select the filter type they wish to apply.

You can construct the filter criterion in code to display the required information, as shown in the example below.

Example

View Example

AutoFilterActions.cs

Worksheet worksheet = workbook.Worksheets["Regional sales"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Enable filtering for the specified cell range.
CellRange range = worksheet["B2:E23"];
worksheet.AutoFilter.Apply(range);

// Filter the data in the "Product" column by an array of values.
worksheet.AutoFilter.Columns[1].ApplyFilterCriteria(new CellValue[] { "Mozzarella di Giovanni", "Gorgonzola Telino" });

AutoFilterActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("Regional sales")
workbook.Worksheets.ActiveWorksheet = worksheet

' Enable filtering for the specified cell range.
Dim range As CellRange = worksheet("B2:E23")
worksheet.AutoFilter.Apply(range)

' Filter the data in the "Product" column by an array of values.
worksheet.AutoFilter.Columns(1).ApplyFilterCriteria(New CellValue() { "Mozzarella di Giovanni", "Gorgonzola Telino" })

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Apply(CellRange) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/AutoFilterActions.cs#L18

CellRange range = worksheet["B2:E23"];
worksheet.AutoFilter.Apply(range);
#endregion #ApplyFilter

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/AutoFilterActions.cs#L43

CellRange range = worksheet["B2:E23"];
worksheet.AutoFilter.Apply(range);
#endregion #ApplyFilter

VB.NET

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/AutoFilterActions.vb#L35

                Dim range As CellRange = worksheet("B2:E23")
                worksheet.AutoFilter.Apply(range)
'                #End Region ' #ApplyFilter

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/AutoFilterActions.vb#L15

            Dim range As DevExpress.Spreadsheet.CellRange = worksheet("B2:E23")
            worksheet.AutoFilter.Apply(range)
#End Region  ' #ApplyFilter

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/AutoFilterActions.vb#L36

                Dim range As CellRange = worksheet("B2:E23")
                worksheet.AutoFilter.Apply(range)
'                #End Region ' #ApplyFilter