Back to Devexpress

SheetAutoFilter.Apply(CellRange) Method

officefileapi-devexpress-dot-spreadsheet-dot-sheetautofilter-dot-apply-x28-devexpress-dot-spreadsheet-dot-cellrange-x29.md

latest5.9 KB
Original Source

SheetAutoFilter.Apply(CellRange) Method

Enables the filtering functionality for the specified range of cells.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
void Apply(
    CellRange range
)
vb
Sub Apply(
    range As CellRange
)

Parameters

NameTypeDescription
rangeCellRange

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

See Also

SheetAutoFilter Interface

SheetAutoFilter Members

DevExpress.Spreadsheet Namespace