AutoFilterColumn.ApplyDynamicFilter(DynamicFilterType) Method

Applies a dynamic filter that shows dates that fall within a specified time period or displays values that are above or below the average.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void ApplyDynamicFilter(
    DynamicFilterType dynamicFilterType
)

VB.NET

Sub ApplyDynamicFilter(
    dynamicFilterType As DynamicFilterType
)

Parameters

Name	Type	Description
dynamicFilterType	DynamicFilterType	A DynamicFilterType enumeration member that specifies the filter criterion.

Remarks

The dynamic filter can change when the data to which the filter is applied or the current system date changes.

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);

// Apply a dynamic filter to the "Sales" column to display only values that are above the average.
worksheet.AutoFilter.Columns[2].ApplyDynamicFilter(DynamicFilterType.AboveAverage);
// Apply a dynamic filter to the "Reported Date" column to display values reported this year.
worksheet.AutoFilter.Columns[3].ApplyDynamicFilter(DynamicFilterType.ThisYear);

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)

' Apply a dynamic filter to the "Sales" column to display only values that are above the average.
worksheet.AutoFilter.Columns(2).ApplyDynamicFilter(DynamicFilterType.AboveAverage)
' Apply a dynamic filter to the "Reported Date" column to display values reported this year.
worksheet.AutoFilter.Columns(3).ApplyDynamicFilter(DynamicFilterType.ThisYear)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ApplyDynamicFilter(DynamicFilterType) 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#L187

// to display only values that are above the average.
worksheet.AutoFilter.Columns[2].ApplyDynamicFilter(DynamicFilterType.AboveAverage);
// Apply a dynamic filter to the "Reported Date" column

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

// Apply a dynamic filter to the "Sales" column to display only values that are above the average.
worksheet.AutoFilter.Columns[2].ApplyDynamicFilter(DynamicFilterType.AboveAverage);

VB.NET

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

' to display only values that are above the average.
worksheet.AutoFilter.Columns(CInt((2))).ApplyDynamicFilter(DevExpress.Spreadsheet.DynamicFilterType.AboveAverage)
' Apply a dynamic filter to the "Reported Date" column

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

' Apply a dynamic filter to the "Sales" column to display only values that are above the average.
worksheet.AutoFilter.Columns(2).ApplyDynamicFilter(DynamicFilterType.AboveAverage)

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

' Apply a dynamic filter to the "Sales" column to display only values that are above the average.
worksheet.AutoFilter.Columns(2).ApplyDynamicFilter(DynamicFilterType.AboveAverage)