How do I create an AutoFilter using XlsIO?
Syncfusion Excel (XlsIO) library is a .NET Excel library used to create, read, and edit Excel documents. Using this library, you can create AutoFilter in Excel using C# and VB.NET by specifying the filter range.
The AutoFilter allows a user to filter items in a list according to set criteria. You can filter text, numbers or dates with AutoFilter.
Steps to create AutoFilter in an Excel file programmatically:
Step 1: Create a new C# console application project.
Create a new C# console application
Step 2: Install Syncfusion.XlsIO.WinForms NuGet package as a reference to your .NET Framework applications from the NuGet.org.
Install NuGet package
Step 3: Include the following namespace in the Program.cs file.
C#
using Syncfusion.XlsIO;
VB.NET
Imports Syncfusion.XlsIO
Step 4: Use the following code snippet to create AutoFilters in an Excel file.
C#
//Create an instance of ExcelEngine
using (ExcelEngine excelEngine = new ExcelEngine())
{
//Set the default application version as Excel 2016
excelEngine.Excel.DefaultVersion = ExcelVersion.Excel2016;
//Create a workbook with a worksheet
//Open existing workbook with data entered
Assembly assembly = typeof(Program).GetTypeInfo().Assembly;
Stream fileStream =
assembly.GetManifestResourceStream("AutoFilters.AutoFilterTemplate.xlsx");
IWorkbook workbook = application.Workbooks.Open(fileStream);
//Access first worksheet from the workbook instance
IWorksheet worksheet = workbook.Worksheets[0];
//Creating an AutoFilter and Specifying the AutoFilter range.
worksheet.AutoFilters.FilterRange = worksheet.Range["A1:B7"];
//Save the workbook to disk in xlsx format
workbook.SaveAs("Output.xlsx");
}
VB.NET
'Create an instance of ExcelEngine
Using excelEngine As ExcelEngine = New ExcelEngine
'Set the default application version as Excel 2016
excelEngine.Excel.DefaultVersion = ExcelVersion.Excel2016
'Open existing workbook with data entered
Dim assembly As Assembly = GetType(Program).GetTypeInfo().Assembly
Dim fileStream As Stream =
assembly.GetManifestResourceStream("AutoFilters.AutoFilterTemplate.xlsx")
Dim workbook As IWorkbook = application.Workbooks.Open(fileStream)
'Access first worksheet from the workbook instance
Dim worksheet As IWorksheet = workbook.Worksheets(0)
'Creating an AutoFilter and Specifying the Autofilter range.
worksheet.AutoFilters.FilterRange = worksheet.Range("A1:B7")
'Save the workbook to disk in xlsx format
workbook.SaveAs("Output.xlsx")
End Using
A complete working example of how to add AutoFilters to Excel in C#/VB.NET can be downloaded from Create AutoFilters.zip
By executing the program, you will get the output Excel file as shown below.
Output Excel document
Take a moment to peruse the documentation, where you can find basic worksheet data manipulation options along with features like Conditional Formatting, worksheet calculations through Formulas, adding Charts in worksheet or workbook, organizing and analyzing data through Tables and Pivot Tables, appending multiple records to worksheet using Template Markers, and most importantly PDF and Image conversions with code examples.
Refer here to explore the rich set of Syncfusion Excel (XlsIO) library features.
Starting with v16.2.0.x, if you reference Syncfusion assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer the link to learn about generating and registering Syncfusion license key in your application to use the components without trial message.