ASP.NET Tip: Exporting Data to Excel

A common request of users is to be able to download data for use in Microsoft Excel. This is actually fairly easy to accomplish without a lot of extra work. I do most of my database work with DataTable objects, as I don't need the overhead of a DataSet. I also have a Database wrapper class that is able to easily retrieve data from a SQL Server database. Once I use my function to get my DataTable, I can start exporting the data. For this example, however, I'll use the traditional SqlDataAdapter method to retrieve the data initially.

There are a few tricks to making this work. First, you have to create an ASPX page with no HTML content in it. The only thing that should be in the ASPX page is the Page directive at the top. The second trick is to clear the existing content and send down a new content type. For Excel, you use a content type of application/vnd.ms-excel. This tells your Web browser to expect something that can be handled within Excel. The third trick is to send down the data tab-delimited per column and a newline at the end of each row. After that, Excel does the rest of the work for you.

Here's the code:

protected void Page_Load(object sender, EventArgs e)
{
   SqlConnection cn = new SqlConnection("yourconnectionstring");
   cn.Open();
   SqlDataAdapter da = new SqlDataAdapter("SELECT * FROM Users", cn);
   DataTable dt = new DataTable();
   da.Fill(dt);
   cn.Close();

   Response.Clear();
   Response.ContentType = "application/vnd.ms-excel";
   string sep = "";
   foreach (DataColumn dc in dt.Columns)
   {
      Response.Write(sep + dc.ColumnName);
      sep = "\t";
   }
   Response.Write("\n");

   int i;
   foreach (DataRow dr in dt.Rows)
   {
      sep = "";
      for (i = 0; i < dt.Columns.Count; i++)
      {
         Response.Write(sep + dr[i].ToString());
         sep = "\t";
      }
      Response.Write("\n");
   }

}

After I open my connection and retrieve my data, I clear the output buffer and send down a new content type, since the default type of text/HTML isn't appropriate in this case. I then loop through the columns and write out the column names, separated by tabs. At the end of the field list, I send down a newline character.

I then loop through the rows of the table and, within each row, loop through the fields. Each field value is printed out in its default format under the appropriate column header. If you have data types, such as Booleans, that should be printed in a different format, you can look at the dt.Columns collection to help determine which data type each field is and use an appropriate conversion function.

The result of running this page is a prompt to open or save the Excel spreadsheet. You can use this code with any query and any database connection. Once you've got the content cleared and the content type set, Excel does the hard work of formatting for you.

About the Author

Eric Smith is the owner of Northstar Computer Systems, a Web-hosting company based in Indianapolis, Indiana. He is also a MCT and MCSD who has been developing with .NET since 2001. In addition, he has written or contributed to 12 books covering .NET, ASP, and Visual Basic. Send him your questions and feedback via e-mail at questions@techniquescentral.com.



Comments

  • Encoding for characters > &H7F

    Posted by ChrisN on 09/26/2006 03:53pm

    That's fine as far as it goes. However if you use characters above &H7F as is common in Europe you will need to encode the data to have Excel display it correctly.  Here's an excerpt showing how to encode into Windows-1252. My data happened to have 16 columns. Variable sQuote is just a convenience to embed a quotation mark.
    
                While oSqlDataReader.Read
                    Dim nUpperBound As Integer = 16
                    For i As Integer = 1 To nUpperBound
                        Dim sFieldName As String = "Data" & i.ToString
                        Dim sUnicodeString As String = sQuote & oSqlDataReader(sFieldName) & sQuote & IIf(i < nUpperBound, ",", vbCrLf)
                        Dim eEncoding As Encoding = Encoding.GetEncoding("Windows-1252")
                        Dim eUnicode As Encoding = Encoding.Unicode
                        Dim byUnicodeBytes As Byte() = eUnicode.GetBytes(sUnicodeString)
                        Dim byEncodedBytes As Byte() = Encoding.Convert(eUnicode, eEncoding, byUnicodeBytes)
                        Response.BinaryWrite(byEncodedBytes)
                    Next
                End While
                Response.End()

    Reply
Leave a Comment
  • Your email address will not be published. All fields are required.

Top White Papers and Webcasts

  • Live Event Date: October 29, 2014 @ 11:00 a.m. ET / 8:00 a.m. PT Are you interested in building a cognitive application using the power of IBM Watson? Need a platform that provides speed and ease for rapidly deploying this application? Join Chris Madison, Watson Solution Architect, as he walks through the process of building a Watson powered application on IBM Bluemix. Chris will talk about the new Watson Services just released on IBM bluemix, but more importantly he will do a step by step cognitive …

  • On-demand Event Event Date: October 23, 2014 Despite the current "virtualize everything" mentality, there are advantages to utilizing physical hardware for certain tasks. This is especially true for backups. In many cases, it is clearly in an organization's best interest to make use of physical, purpose-built backup appliances rather than relying on virtual backup software (VBA - Virtual Backup Appliances). Join us for this webcast to learn why physical appliances are preferable to virtual backup appliances, …

Most Popular Programming Stories

More for Developers

Latest Developer Headlines

RSS Feeds