Click here to Skip to main content
Click here to Skip to main content
Go to top

DataTable to Excel

, 15 Apr 2007
Rate this:
Please Sign up or sign in to vote.
A quick and easy way to format and export a DataTable to an Excel spreadsheet

Introduction

A common task I've run across is the need to export a DataTable to an Excel spreadsheet. It's a great way to distribute reports, etc. to users. It also seems like an obvious translation, considering the way that DataSets are usually presented in DataGrid controls.

Unfortunately, the methods I have found so far for doing this have been rather ugly - they involve iterating through the DataTable items and manually writing to the output file, line-by-line, in the correct format. Then, in a stroke of luck, I was assigned a simple ASP.NET project at work (I normally work in Windows Forms), and while working on that, I found a very simple way of accomplishing this task, with the added bonus of being able to easily format the output spreadsheet.

Using the code

The basic trick is that Excel can open HTML tables, so the idea is to create a DataGrid web control (which you can use whether or not your project is in ASP.NET), use databinding to fill the control with information from your DataSet, set any formatting (bolded text, background colors, etc), then have the DataGrid render itself to an output file with Excel's ".XLS" extension.

Please note that you need to add a reference to "System.Web" in your project in order to use the System.Web.UI.WebControls namespace!

Here is an example. I am using a DataSet named "data" containing a Table named "Stats":

// create the DataGrid and perform the databinding
System.Web.UI.WebControls.DataGrid grid = 
            new System.Web.UI.WebControls.DataGrid();
grid.HeaderStyle.Font.Bold = true;
grid.DataSource = data;
grid.DataMember = data.Stats.TableName;

grid.DataBind();

// render the DataGrid control to a file
using(StreamWriter sw = new StreamWriter("c:\\test.xls"))
{
    using(HtmlTextWriter hw = new HtmlTextWriter(sw))
    {
        grid.RenderControl(hw);
    }
}

If you then open the output file in a text editor, you will see that it just contains simple HTML.

Points of Interest

As someone who works mostly with Windows Forms, some of the above code seems non-obvious. Here are some important differences I found between the regular Windows Forms controls and the Web controls:

  • Databinding with Web controls must be performed manually! You set the DataSource and DataMember properties as usual, but the databinding will not occur until you make the "DataBind()" call yourself.
  • Rendering the control requires two output streams: one is the HtmlTextWriter, which is what the Web grid can render itself to, and the second is the StreamWriter, which the HtmlTextWriter writes itself to. Compare this to a normal ASP.NET webpage, where instead of using a StreamWriter to write to a file, the HtmlTextWriter would probably write to a web page in memory.

Finally, a word of warning - once the user has opened the file in Excel and saved changes to it, the file will no longer contain a simple HTML table as Excel will rewrite it with its own file format.

License

This article, along with any associated source code and files, is licensed under The MIT License

Share

About the Author

Jacob Klint
Software Developer
United States United States
No Biography provided

Comments and Discussions

 
QuestionException :( Pinmembersuvsuv27-Nov-12 19:28 
GeneralSimple and effective PinmemberQCJim6-Jan-12 2:31 
QuestionProblem while exporting special characters like ü Pinmembervishal pareek1-Sep-11 2:41 
QuestionA proper way PinmemberCikaPero20-Jul-11 22:29 
GeneralBest Way Pinmemberabhijitwalke25-May-11 16:53 
GeneralMy vote of 4 PinmemberAmar Karandikar5-Sep-10 23:39 
GeneralIt works. Thanks! Pinmemberlarno8-May-10 5:10 
GeneralGreat Help.. Thanks Pinmemberhardikprogram20-May-09 4:17 
QuestionHow to add formating to Excel after Exporting PinmemberSachin Pisal19-Jan-09 7:05 
GeneralGreat and simple Solution. Thanks! PinmemberMember 14319668-Aug-08 13:32 
I'ved worked with several methods to export tables to excel and all of them suck! Plus most of them have bad memory management and are more slow. This is just Great for a simple task. Thanks a lot!
 
Ariel
General5 from me, too PinmemberScott Bruno27-Jun-08 9:12 
GeneralAlternative way PinmemberBarbaMariolino17-Jun-08 2:33 
General5 from me! PinmemberDuong Tran14-Jun-08 20:47 
Generaldownloading this file PinmemberFrank Silva3-Jan-08 2:35 
GeneralRe: downloading this file PinmemberJacob Klint3-Jan-08 8:25 
GeneralHello Pinmemberfarhit26-Oct-07 1:18 
Generalmay need flush and close, too PinmemberCathieA31-Jul-07 10:45 
GeneralRe: may need flush and close, too PinmemberJacob Klint14-Aug-07 13:08 
QuestionSupported by Excel 2000? Pinmemberlizrd82512-Jun-07 10:36 
AnswerRe: Supported by Excel 2000? PinmemberJacob Klint12-Jun-07 13:18 
GeneralRe: Supported by Excel 2000? Pinmemberlizrd82513-Jun-07 10:10 
GeneralThanks - saved me loads of time! Pinmembernzmike8-May-07 12:32 
Questioncovert to VB Pinmemberbobcarrretta17-Apr-07 6:32 
AnswerRe: covert to VB PinmemberBen[dog]17-Apr-07 11:55 
GeneralThis is not how you export data! Pinmemberyang yu 179999916-Apr-07 6:48 

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

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

| Advertise | Privacy | Mobile
Web03 | 2.8.140922.1 | Last Updated 15 Apr 2007
Article Copyright 2007 by Jacob Klint
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid