Worksheet.AutoFilter Property

Provides access to an object that contains options to filter data in a worksheet.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v20.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

NuGet Packages: DevExpress.Spreadsheet.Core, DevExpress.WindowsDesktop.Spreadsheet.Core

Declaration

C#

SheetAutoFilter AutoFilter { get; }

VB.NET

ReadOnly Property AutoFilter As SheetAutoFilter

Property Value

Type	Description
SheetAutoFilter	An object that implements filtering for cell ranges in a worksheet.

Remarks

Use the Worksheet.AutoFilter property to get access to the SheetAutoFilter object that allows you to apply different types of filters to cell ranges in a worksheet. Call the SheetAutoFilter.Apply method to enable filtering for a specific cell range.

To filter data in a table, use the Table.AutoFilter property.

Example

This example demonstrates how to use the SheetAutoFilter.Apply method to enable filtering for a cell range and filter data in a column by an array of values.

View Example

AutoFilterActions.vb

' 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"})

AutoFilterActions.cs

// 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"});