Back to Devexpress

AutoFilterColumn.ApplyFilterCriteria(FilterValue) Method

officefileapi-devexpress-dot-spreadsheet-dot-autofiltercolumn-dot-applyfiltercriteria-x28-devexpress-dot-spreadsheet-dot-filtervalue-x29.md

latest6.9 KB
Original Source

AutoFilterColumn.ApplyFilterCriteria(FilterValue) Method

Filters data by values.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
void ApplyFilterCriteria(
    FilterValue filters
)
vb
Sub ApplyFilterCriteria(
    filters As FilterValue
)

Parameters

NameTypeDescription
filtersFilterValue

A FilterValue object containing values to be used in a filter.

|

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

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

The following code snippets (auto-collected from DevExpress Examples) contain references to the ApplyFilterCriteria(FilterValue) 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.

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

csharp
// Filter the data in the "Product" column by a specific value.
worksheet.AutoFilter.Columns[1].ApplyFilterCriteria("Mozzarella di Giovanni");
#endregion #FilterByValue

wpf-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/AutoFilterActions.cs#L153

csharp
// Filter the data in the "Product" column by a specific value.
worksheet.AutoFilter.Columns[1].ApplyFilterCriteria("Mozzarella di Giovanni");
#endregion #FilterByValue

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

csharp
// Filter data in the "Product" column by a specific value.
worksheet.AutoFilter.Columns[1].ApplyFilterCriteria("Mozzarella di Giovanni");
#endregion #FilterBySingleValue

winforms-spreadsheet-use-custom-cell-editors/CS/DevAVInvoicing/Form1.cs#L144

csharp
storesTable.AutoFilter.Clear();
storesTable.AutoFilter.Columns[1].ApplyFilterCriteria(customerId);
// Select the default store and assign it to the cell G12 on the "Invoice" worksheet.

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

vb
' Filter the data in the "Product" column by a specific value.
                worksheet.AutoFilter.Columns(1).ApplyFilterCriteria("Mozzarella di Giovanni")
' #End Region ' #FilterByValue

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

vb
' Filter the data in the "Product" column by a specific value.
                worksheet.AutoFilter.Columns(1).ApplyFilterCriteria("Mozzarella di Giovanni")
' #End Region ' #FilterByValue

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

vb
' Filter data in the "Product" column by a specific value.
            worksheet.AutoFilter.Columns(1).ApplyFilterCriteria("Mozzarella di Giovanni")
' #End Region ' #FilterBySingleValue

winforms-spreadsheet-use-custom-cell-editors/VB/DevAVInvoicing/Form1.vb#L132

vb
storesTable.AutoFilter.Clear()
storesTable.AutoFilter.Columns(1).ApplyFilterCriteria(customerId)
' Select the default store and assign it to the cell G12 on the "Invoice" worksheet.

See Also

How to: Filter by Cell Values

AutoFilterColumn Interface

AutoFilterColumn Members

DevExpress.Spreadsheet Namespace