XlDynamicFilter(XlDynamicFilterType) Constructor

Initializes a new instance of the XlDynamicFilter class with the specified settings.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public XlDynamicFilter(
    XlDynamicFilterType dynamicFilterType
)

VB.NET

Public Sub New(
    dynamicFilterType As XlDynamicFilterType
)

Parameters

Name	Type	Description
dynamicFilterType	XlDynamicFilterType	An XlDynamicFilterType enumeration member that specifies the dynamic filter type. This value is assigned to the XlDynamicFilter.DynamicFilterType property.

Remarks

This constructor can be used to create a dynamic filter of one of the following types:

• XlDynamicFilterType.Today, XlDynamicFilterType.Yesterday, XlDynamicFilterType.Tomorrow;
• XlDynamicFilterType.NextWeek, XlDynamicFilterType.ThisWeek, XlDynamicFilterType.LastWeek;
• XlDynamicFilterType.NextMonth, XlDynamicFilterType.ThisMonth, XlDynamicFilterType.LastMonth;
• XlDynamicFilterType.NextQuarter, XlDynamicFilterType.ThisQuarter, XlDynamicFilterType.LastQuarter;
• XlDynamicFilterType.NextYear, XlDynamicFilterType.ThisYear, XlDynamicFilterType.LastYear, XlDynamicFilterType.YearToDate;
• XlDynamicFilterType.Quarter1, XlDynamicFilterType.Quarter2, XlDynamicFilterType.Quarter3, XlDynamicFilterType.Quarter4;
• XlDynamicFilterType.Month1, XlDynamicFilterType.Month2, XlDynamicFilterType.Month3, XlDynamicFilterType.Month4, XlDynamicFilterType.Month5, XlDynamicFilterType.Month6, XlDynamicFilterType.Month7, XlDynamicFilterType.Month8, XlDynamicFilterType.Month9, XlDynamicFilterType.Month10, XlDynamicFilterType.Month11, and XlDynamicFilterType.Month12.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/excel-export-api-examples

DataActions.cs

// Generate the header row.
using (IXlRow row = sheet.CreateRow())
    row.BulkCells(new string[] { "Date", "Customer", "Total" }, headerRowFormatting);

// Create a dynamic filter to display dates that occur this month.
XlDynamicFilter filter = new XlDynamicFilter(XlDynamicFilterType.ThisMonth);
sheet.AutoFilterColumns.Add(new XlFilterColumn(0, filter));
// Start filtering data.
sheet.BeginFiltering(sheet.DataRange);

// Generate data for the document.
string[] customers = new string[] { "Tom's Club", "E-Mart", "K&S Music", "Walters" };
int[] amount = new int[] { 6750, 4500, 3550, 4250, 5500, 6250, 5325, 4235 };
for (int i = 0; i < 8; i++)
{
    using (IXlRow row = sheet.CreateRow())
    {
        using (IXlCell cell = row.CreateCell())
        {
            cell.Value = DateTime.Now.AddDays(-7 * (7 - i));
            cell.ApplyFormatting(rowFormatting);
        }
        using (IXlCell cell = row.CreateCell())
        {
            cell.Value = customers[i % 4];
            cell.ApplyFormatting(rowFormatting);
        }
        using (IXlCell cell = row.CreateCell())
        {
            cell.Value = amount[i];
            cell.ApplyFormatting(rowFormatting);
        }
    }
}

// Finish filtering.
sheet.EndFiltering();

DataActions.vb

' Generate the header row.
Using row As IXlRow = sheet.CreateRow()
    row.BulkCells(New String() {"Date", "Customer", "Total"}, headerRowFormatting)
End Using

' Create a dynamic filter to display dates that occur this month.
Dim filter As New XlDynamicFilter(XlDynamicFilterType.ThisMonth)
sheet.AutoFilterColumns.Add(New XlFilterColumn(0, filter))
' Start filtering data.
sheet.BeginFiltering(sheet.DataRange)

' Generate data for the document.
Dim customers() As String = {"Tom's Club", "E-Mart", "K&S Music", "Walters"}
Dim amount() As Integer = {6750, 4500, 3550, 4250, 5500, 6250, 5325, 4235}
For i As Integer = 0 To 7
    Using row As IXlRow = sheet.CreateRow()
        Using cell As IXlCell = row.CreateCell()
            cell.Value = Date.Now.AddDays(-7 * (7 - i))
            cell.ApplyFormatting(rowFormatting)
        End Using
        Using cell As IXlCell = row.CreateCell()
            cell.Value = customers(i Mod 4)
            cell.ApplyFormatting(rowFormatting)
        End Using
        Using cell As IXlCell = row.CreateCell()
            cell.Value = amount(i)
            cell.ApplyFormatting(rowFormatting)
        End Using
    End Using
Next i

' Finish filtering.
sheet.EndFiltering()