Click here to Skip to main content
15,797,925 members
Articles / Web Development / ASP.NET

A free "Export to Excel" C# class, using OpenXML

Rate me:
Please Sign up or sign in to vote.
4.88/5 (103 votes)
17 Dec 2013CPOL4 min read 486.2K   19.2K   182   140
How to easily add an "export to Excel" feature to your app

Introduction

It's amazing that even now, in 2013, there are so many developers still asking for help on how to write C# and VB.NET code to export their data to Excel.

Even worse, a lot of them will stumble on articles suggesting that they should write their data to a comma-separated file, but to give the file a .xls extension.

So today, I'm going to walkthrough how to use my C# "Export to Excel" class which you can add to your C# WinForms / WPF / ASP.NET application, using one line of code.

Depending on whether your data is stored in a DataSet, DataTable, or List<>, you simply need to call one of these three functions, and tell them what (Excel) file name you want to write to.

C#
public static bool CreateExcelDocument<T>(List<T> list, string ExcelFilename
public static bool CreateExcelDocument(DataTable dt, string ExcelFilename
public static bool CreateExcelDocument(DataSet ds, string ExcelFilename)

Here's a simple example.

We create a DataSet, fill it with some data (just add your own CreateSampleData function), then call the CreateExcelFile.CreateExcelDocument function, passing it the DataSet and a filename:

C#
// Step 1: Create a DataSet, and put some sample data in it
DataSet ds = CreateSampleData();

// Step 2: Create the Excel .xlsx file
try
{
    CreateExcelFile.CreateExcelDocument(ds, "C:\\Sample.xlsx");
}
catch (Exception ex)
{ 
    MessageBox.Show("Couldn't create Excel file.\r\nException: " + ex.Message);
    return;
}   

And that's all you have to do. The CreateExcelDocument function will create a "real" Excel file for you.

For example, if you had a created a DataSet containing three DataTables called:

  • Drivers
  • Vehicles,
  • Vehicle Owners,

..then here's what your Excel file would look like. The class would create one worksheet per DataTable, and each worksheet would contain the data from that DataTable.

Sample spreadsheet

The full source code for this C# class is freely downloadable here (click on the "Browse code" link in the left-hand panel), or you can download this full demo, plus a VB.NET version of the class, from my blog, MikesKnowledgeBase.

Adding the library to your application

The C# code above shows how easy it is to call the CreateExcelFile class.

C#
DataSet ds = CreateSampleData();
CreateExcelFile.CreateExcelDocument(ds, "C:\\Sample.xlsx");

However, to use this library, you'll need to add two files from the free Microsoft OpenXML SDK:

  • DocumentFormat.OpenXml.dll: From the free Microsoft Open XML SDK library
  • WindowsBase.dll: From the Microsoft .NET Framework library

Add these two DLLs to your project's References section, and remember to set them to "Copy Local".

Copy Local

Then, just download the CreateExcelFile.cs file (via the "Browse code" link in CodeProject's left-hand panel), and add it to your application. 

And that's it.

Regardless of if your data is stored in a List<>, DataTable, or DataSet, you can export it to a "real" Office 2007 Excel .xlsx file using that one line of code.

And because it is created using the OpenXML library, you can run this code on machines which don't have Excel installed.

ASP.NET

For ASP.NET developers, I've added three extra functions.

C#
public static bool CreateExcelDocument<T>(List<T> list, string filename, System.Web.HttpResponse Response)
public static bool CreateExcelDocument(DataTable dt, string filename, System.Web.HttpResponse Response)
public static bool CreateExcelDocument(DataSet ds, string filename, System.Web.HttpResponse Response)

Rather than creating the Excel file in a temporary directory, then having to load in the file and output it to the webpage's HttpResponse, you can get the library to write directly to the HttpResponse.

However, by default, this functionality is disabled (to prevent build issues for the non ASP.NET developers). To enable these three functions, you need to make two changes.

First, uncomment the top line of the CreateExcelFile.cs code, so that it now reads:

C#
#define INCLUDE_WEB_FUNCTIONS   

Now, you need to add a Reference to the System.Web .NET library:

Adding a reference

Once you've done these two steps, the CreateExcelFile library is ready to go.

For example, in this example, my ASP.NET C# code has a list of Employee records, stored in a List<Employeee>. I add an "Export to Excel" button to my webpage, and when the user clicks on it, I just need one simple call to the CreateExcelFile class.

C#
// In this example, I have a defined a List of my Employee objects.<br />class Employee;
List<Employee> listOfEmployees = new List<Employee>();
...
 
// The following ASP.Net code gets run when I click on my "Export to Excel" button.
protected void btnExportToExcel_Click(object sender, EventArgs e)
{
    // It doesn't get much easier than this...
    CreateExcelFile.CreateExcelDocument(listOfEmployees, "Employees.xlsx", Response);
}

And that's it. A real Excel file, in one line of code.

Going forward

You'll notice that this library is excellent for one job - writing plain, boring data to an Excel file. I haven't attempted to add any classes to add formatting, colors, pivot tables or anything else.

However, this class is an excellent way to get started (without paying for third-party software to create the Excel file for you), and if you want to take this further, you'll soon find that Googling will easily find you extra source code to add on top of this.

For example, if you wanted to add a background color to some of the cells in the Excel file, simply Google "open XML background color" and you'll have many articles showing you how to do this.

The reason I wrote this article is that I found that it was very hard to find a free, easy to use C# library which actually created the OpenXML Excel file in the first place.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer
Switzerland Switzerland
Full-stack Software Developer, working for an insurance company in Zurich, Switzerland.

More developer tips'n'trip at my website:
http://www.MikesKnowledgeBase.com

Comments and Discussions

 
SuggestionFilter strange behavior; Sort Order Pin
Alexander Sharykin30-Jan-14 23:43
Alexander Sharykin30-Jan-14 23:43 
QuestionIt works really fine. Pin
dietmar paul schoder22-Jan-14 8:25
professionaldietmar paul schoder22-Jan-14 8:25 
AnswerRe: It works really fine. Pin
Michael Gledhill22-Jan-14 8:45
Michael Gledhill22-Jan-14 8:45 
GeneralRe: It works really fine. Pin
dietmar paul schoder22-Jan-14 8:48
professionaldietmar paul schoder22-Jan-14 8:48 
GeneralRe: It works really fine. Pin
Michael Gledhill22-Jan-14 9:02
Michael Gledhill22-Jan-14 9:02 
GeneralAnother old day method: HTML Table + XLS extension Pin
adriancs7-Jan-14 21:51
professionaladriancs7-Jan-14 21:51 
QuestionDefined excel file name Pin
Member 1047349419-Dec-13 20:47
Member 1047349419-Dec-13 20:47 
AnswerRe: Defined excel file name Pin
Mike Gledhill20-Dec-13 0:45
Mike Gledhill20-Dec-13 0:45 
If I understand your question correctly, then you just need to define a "Excel filename" TextBox in your application, and pass it's value to the CreateExcelDocument function:

C#
DataSet ds = CreateSampleData();
CreateExcelFile.CreateExcelDocument(ds, textboxExcelFilename.Text);


My C# library will then create an .xlsx file, with the filename provided by the user.

Is this what you were asking...?
GeneralRe: Defined excel file name Pin
Member 1047349420-Dec-13 4:46
Member 1047349420-Dec-13 4:46 
QuestionCSV Pin
FatCatProgrammer17-Dec-13 8:27
FatCatProgrammer17-Dec-13 8:27 
AnswerRe: CSV Pin
Philippe Mori17-Dec-13 13:47
Philippe Mori17-Dec-13 13:47 
GeneralRe: CSV Pin
FatCatProgrammer17-Dec-13 15:58
FatCatProgrammer17-Dec-13 15:58 
GeneralRe: CSV Pin
Philippe Mori17-Dec-13 16:21
Philippe Mori17-Dec-13 16:21 
GeneralRe: CSV Pin
FatCatProgrammer18-Dec-13 4:59
FatCatProgrammer18-Dec-13 4:59 
GeneralRe: CSV Pin
Philippe Mori18-Dec-13 6:25
Philippe Mori18-Dec-13 6:25 
GeneralRe: CSV Pin
FatCatProgrammer24-Dec-13 4:41
FatCatProgrammer24-Dec-13 4:41 
AnswerRe: CSV Pin
Mike Gledhill18-Dec-13 6:11
Mike Gledhill18-Dec-13 6:11 
QuestionClosedXml Pin
wvd_vegt11-Dec-13 10:03
professionalwvd_vegt11-Dec-13 10:03 
QuestionModifications for Webmatrix Pin
richosborne10-Dec-13 10:37
richosborne10-Dec-13 10:37 
AnswerRe: Modifications for Webmatrix Pin
Mike Gledhill10-Dec-13 19:35
Mike Gledhill10-Dec-13 19:35 
QuestionGood job Mike Pin
gillindsay10-Dec-13 6:16
professionalgillindsay10-Dec-13 6:16 
QuestionPerfect !!! Pin
Norbert Haberl10-Dec-13 1:12
Norbert Haberl10-Dec-13 1:12 
AnswerRe: Perfect !!! Pin
Mike Gledhill10-Dec-13 1:59
Mike Gledhill10-Dec-13 1:59 
QuestionTemplated document creation? Pin
V.Lorz10-Dec-13 0:24
V.Lorz10-Dec-13 0:24 
AnswerRe: Templated document creation? Pin
bwellschicago10-Dec-13 5:20
bwellschicago10-Dec-13 5:20 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.