AutoFilterColumn.ApplyFilterCriteria(FilterValue) Method

Filters data by values.

Namespace: DevExpress.Spreadsheet

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

Declaration

C#

void ApplyFilterCriteria(
    FilterValue filters
)

VB.NET

Sub ApplyFilterCriteria(
    filters As FilterValue
)

Parameters

Name	Type	Description
filters	FilterValue	A FilterValue object containing values to be used in a filter.

Example

This example demonstrates how to activate the filtering functionality for a range of cells using the SheetAutoFilter.Apply method and filter data in the specified column by an array of values.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-part-2-e4832

AutoFilterActions.vb

' Enable filtering for the specified cell range.
Dim range As 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.cs

// Enable filtering for the specified cell range.
Range 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"});

Related GitHub Examples

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.

C#

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

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

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

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

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

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

how-to-use-custom-cell-editors-to-create-a-data-entry-form-t419595/CS/DevAVInvoicing/Form1.cs#L144

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

VB.NET

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

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

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

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

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

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

how-to-use-custom-cell-editors-to-create-a-data-entry-form-t419595/VB/DevAVInvoicing/Form1.vb#L148

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