A FREE “Export to Excel” C# class, using OpenXML

It’s amazing that even now, in 2014, 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.

public static bool CreateExcelDocument(List 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:

// 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.

The full source code for this C# class is freely downloadable here
Adding the library to your application

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

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”

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 2-10 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.

public static bool CreateExcelDocument(List 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:

#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. 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.

// In this example, I have a defined a List of my Employee objects.
class Employee;

List listOfEmployees = new List();

// 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.

Download File

Advertisements

One thought on “A FREE “Export to Excel” C# class, using OpenXML”

  1. This solution is fantastic! And just as simple as you said. It saved me a ton of time. Highly encourage others to use this, it’s simple, simple, simple. If you are using SP 2010 make sure you use version 2.0 of Open XML SDK – it uses the 3.5 .Net framework. (The 2.5 version of OXML uses .Net 4.0 so doesn’t work with SP2010.)

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s