Version

Filtering Worksheet Regions (Infragistics Excel Engine)

Topic Overview

Purpose

This topic describes how to filter a worksheet region column, set through the FilterSettings property.

In this topic

This topic contains the following sections:

Introduction

Code Examples Overview

Code Example: Average Filtering

Code Example: Custom Filtering

Code Example: Date Period Filtering

Code Example: Fill Filtering

Code Example: Fixed Values Filtering

Code Example: Relative Date Range Filtering

Code Example: Top or Bottom Filtering

Code Example: Year to Date Filtering

Related Content

Introduction

Filtering is done by establishing a region and applying one of several methods through a Worksheet’s FilterSettings property. Note, only a single region can be applied to a worksheet at a time. When the filter is applied on a column mapped to a region, all filters in the region will be reevaluated to determine which rows should be visible. This operation will show rows where all cells meet their region columns’ filter criteria.

If the data in the region is changed or you change the Hidden property of the rows subsequently, the filter conditions will not be reevaluated. The Filter conditions in a region are only reapplied when region column filters are added, removed, modified, or when the ReapplyFilters method is called on the FilterSettings property.

The following filter methods are available to set on columns:

Filter type Description

Only cells with dates in a specific month or quarter of any year will be displayed. All other cells will be hidden.

Cells are filtered whether they are above or below the average value of all cells in the column.

Cells are filtered based on one or two custom conditions.

Only cells with a specific fill will be displayed. All other cells will be hidden.

Only cells with a specific font color will be displayed. All other cells will be hidden.

Cells which only match specific display values or which fall within a specific group of dates/times will be displayed. All other cells will be hidden.

Only cells with date values can be filtered based on whether they occur within a relative time range of the date when the filter was applied, such as the next day or the previous quarter.

This filter allows for the following types of filters:

  • Only the top N values are visible

  • Only the bottom N values are visible

  • Only the top N% of values are visible

  • Only the bottom N% of the values are visible

Only cells with date values can be filtered if they occur between the start of the year and the date on which the filter is applied.

Code Examples Overview

Overview

The following table lists the code examples included in this topic.

Example Description

Average Filtering

This code example shows how cells can be filtered based on whether they are above or below the average value of all cells in the column.

Custom Filtering

This code example shows how cells can be filtered according to one or two CustomFilterConditions.

Date Period Filtering

This code filters only cells with dates in a specific month or quarter. All other cells will be hidden.

Fill Filtering

This code filters only cells with specific fill. All other cells will be hidden.

Fixed Values Filtering

This code filters only cells which have specific display values. All other cells will be hidden.

Relative Date Range Filtering

This code example shows how to filter date values based on whether they occur within a relative time range of the date on which the filter is applied.

Top or Bottom Filtering

This code example shows how to filter the top 10% of values in the column.

Year To Date Filtering

This code example shows how cells with date values can be filtered if they occur between the start of the year and the date o the filter is applied.

Code Example: Average Filtering

Description

This code shows how to filter cells above the average value of all cells in the column. Filtering below average values is done in a similar manner.

The code in this example creates a workbook, and worksheet to modify the specified region through the FilterSettings . After that, a filter is applied on a column of the region. In the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
' Apply average filter to first available column.
worksheet.FilterSettings.ApplyAverageFilter(0, Infragistics.Documents.Excel.Filtering.AverageFilterType.AboveAverage)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
// Apply average filter to first available column.
worksheet.FilterSettings.ApplyAverageFilter(0, Infragistics.Documents.Excel.Filtering.AverageFilterType.AboveAverage);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Custom Filtering

Description

This code shows how to filter cells using a CustomFilterCondition condition

The code in this example creates a workbook with a region. After that a CustomFilterCondition is created, with a specified ExcelComparisonOperator and a match string. The custom filter is applied and in the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply a custom filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
' Create custom filter condition
Dim matchWordCondition As New Infragistics.Documents.Excel.Filtering.CustomFilterCondition(Infragistics.Documents.Excel.Filtering.ExcelComparisonOperator.Equals, "High")
' Apply custom filter
worksheet.FilterSettings.ApplyCustomFilter(0, matchWordCondition)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
// Create custom filter condition
Infragistics.Documents.Excel.Filtering.CustomFilterCondition matchWordCondition = new Infragistics.Documents.Excel.Filtering.CustomFilterCondition(
    Infragistics.Documents.Excel.Filtering.ExcelComparisonOperator.Equals, "High");
// Apply custom filter
worksheet.FilterSettings.ApplyCustomFilter(matchWordCondition);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Date Period Filtering

Description

This code filters cells with dates in a specific month or quarter.

The code in this example creates a workbook with a region. After that, a Date Period Filter is applied on a column of the region which contains dates. In the end, workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
' Apply Date Period Filter
' If you choose DatePeriodFilterType.Month, second argument represents months from January, 1, to December, 12
' and can take values 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
' If you choose DatePeriodFilterType.Quarter, second argument represents the four quaters of the year - Q1, Q2, Q3 and Q4,
' and can take values 1, 2, 3 and 4.
' Code below accepts all dates in August.
worksheet.FilterSettings.ApplyDatePeriodFilter(Infragistics.Documents.Excel.Filtering.DatePeriodFilterType.Month, 8)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
// Apply Date Period Filter
// If you choose DatePeriodFilterType.Month, second argument represents months from January, 1, to December, 12
// and can take values 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
// If you choose DatePeriodFilterType.Quarter, second argument represents the four quaters of the year - Q1, Q2, Q3 and Q4,
// and can take values 1, 2, 3 and 4.
// Code below accept all dates in August.
worksheet.FilterSettings.ApplyDatePeriodFilter(Infragistics.Documents.Excel.Filtering.DatePeriodFilterType.Month, 8);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Fill Filtering

Description

This code shows how to filter cells with specific background fill.

The code in this example creates a workbook with a region. After that, a CellFill is created which will be used for matching. A Fill Filter is applied and in the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
Dim lastRow As Integer = worksheet.FilterSettings.LastRow
Dim rand As New System.Random()
' Set Red background for random cells from first column
Dim i As Integer = 1
While i < lastRow
    If rand.[Next](2) = 1 Then
        workbook.Worksheets(0).Rows(i).Cells(0).CellFormat.Fill = Infragistics.Documents.Excel.CellFill.CreateSolidFill(New Infragistics.Documents.Excel.WorkbookColorInfo(Infragistics.Documents.Excel.WorkbookThemeColorType.Accent1))
    End If
    i += 1
End While
' Create cell fill argument
Dim cellFill As Infragistics.Documents.Excel.CellFill = Infragistics.Documents.Excel.CellFill.CreateSolidFill(New Infragistics.Documents.Excel.WorkbookColorInfo(Infragistics.Documents.Excel.WorkbookThemeColorType.Accent1))
' Apply FillFilter
worksheet.FilterSettings.ApplyFillFilter(0, cellFill)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
int lastRow = worksheet.FilterSettings.LastRow;
System.Random rand = new System.Random();
// Set Red background for random cells from first column
for (int i = 1; i < lastRow; i++)
{
    if (rand.Next(2) == 1)
    {
        workbook.Worksheets[0].Rows[i].Cells[0].CellFormat.Fill = Infragistics.Documents.Excel.CellFill.CreateSolidFill(
        new Infragistics.Documents.Excel.WorkbookColorInfo(Infragistics.Documents.Excel.WorkbookThemeColorType.Accent1));
    }
}
// Create cell fill argument
Infragistics.Documents.Excel.CellFill cellFill = Infragistics.Documents.Excel.CellFill.CreateSolidFill(
    new Infragistics.Documents.Excel.WorkbookColorInfo(Infragistics.Documents.Excel.WorkbookThemeColorType.Accent1));
// Apply FillFilter
worksheet.FilterSettings.ApplyFillFilter(0, cellFill);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Fixed Values Filtering

Description

This code filters cells which have specific display values.

The code in this example creates a workbook with a region. After that, a string array is created which holds all fixed values for filtering and the Fixed Values Filter is applied. The cells from the column on which filter is applied have different string values. In the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
' Create a category array of values, to be used in filtering
Dim categories As String() = New String() {"High", "Medium"}
' Apply FixedValuesFilter
worksheet.FilterSettings.ApplyFixedValuesFilter(0, False, categories)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
// Create a category array of values, to be used in filtering
string[] categories = new string[] {"High", "Medium"};
// Apply FixedValuesFilter
worksheet.FilterSettings.ApplyFixedValuesFilter(0, false, categories);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Relative Date Range Filtering

Description

This code example shows how to filter date values based on whether they occur within a relative time range of the date.

The code in this example creates a workbook with a region. After that, a Relative Date Values Filter is applied. In the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
' Apply RelativeDateRangeFilter
worksheet.FilterSettings.ApplyRelativeDateRangeFilter(0, Infragistics.Documents.Excel.Filtering.RelativeDateRangeOffset.Current, Infragistics.Documents.Excel.Filtering.RelativeDateRangeDuration.Month)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
// Apply RelativeDateRangeFilter
worksheet.FilterSettings.ApplyRelativeDateRangeFilter(0,
    Infragistics.Documents.Excel.Filtering.RelativeDateRangeOffset.Current,
    Infragistics.Documents.Excel.Filtering.RelativeDateRangeDuration.Month);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Top or Bottom Filtering

Description

This code example shows how to filter the top 10% of values from a column.

The code in this example creates a workbook with a region. After that, a filter is applied which filters the top 10% of values. In the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
worksheet.FilterSettings.ApplyTopOrBottomFilter(0, Infragistics.Documents.Excel.Filtering.TopOrBottomFilterType.TopPercentage, 20)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
worksheet.FilterSettings.ApplyTopOrBottomFilter(0, Infragistics.Documents.Excel.Filtering.TopOrBottomFilterType.TopPercentage, 20);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Code Example: Year to Date Filtering

Description

This code example shows how cells with date values can be filtered if they occur between the start of the year and the date on which the filter is applied.

The code in this example creates a workbook with a region. After that, the Year-To-Date Filter is applied. In the end, the workbook is saved so the filtered region can be seen.

Prerequisites

In this example, a new instance of a workbook and worksheet are created in order apply the given filter to the filter region.

Code

In Visual Basic:

Dim workbook As Infragistics.Documents.Excel.Workbook = ExcelExampleRegion.CreateExampleWorkbook()
Dim worksheet as Infragistics.Documents.Excel.WorkSheet = workbook.Worksheets[0]
' Set a worksheet region on the active worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2")
worksheet.FilterSettings.ApplyYearToDateFilter(0)
workbook.Save("C:\WorksheetFiltering-Filtered.xlsx")

In C#:

Infragistics.Documents.Excel.Workbook workbook = ExcelExampleRegion.CreateExampleWorkbook();
Infragistics.Documents.Excel.Worksheet worksheet = workbook.Worksheets[0];
// Set a worksheet region on the current worksheet's filter settings.
worksheet.FilterSettings.SetRegion("A2:G2");
worksheet.FilterSettings.ApplyYearToDateFilter(0);
workbook.Save("C:\\WorksheetFiltering-Filtered.xlsx");

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic explains how to configure and perform worksheet level sorting.

This topic describes how to filter columns in tables.

This section is your gateway to important task-based information that will help you to effectively use the various features and functionalities provided by the Infragistics Excel Engine.

Samples

The following samples provide additional information related to this topic.

Sample Purpose

Named Tables

This sample demonstrates how to work with Named Tables in Excel. You can format worksheet regions as tables and specify a name for each table. Once configured you can get a table by name and specify styles to apply to a table. Further, you can get and set sort conditions and filters for each column of a table. Finally, you can specify different options - table style, column sort directions, column filters, and save the Excel file to see the applied settings