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

Export Silverlight DataGrid to Excel XML/CSV

Rate me:
Please Sign up or sign in to vote.
5.00/5 (25 votes)
1 Dec 2009CPOL2 min read 202.2K   5K   52   67
This article explains how to export the contents of a DataGrid to Excel/CSV.

Introduction

There are several reasons for the end user to export data from an application into an Excel compatible format (mostly for further analysis/usage or data). This article explains how to include data export capability to Silverlight DataGrid.

Background

I am working on migrating some ASP.NET code to a Silverlight application. One of the features that I felt lacking in Silverlight is the ability to export the contents of a DataGrid to the end user. To address this issue, I created an extension for DataGrid control. When the attached file (DataGridExtensions.cs) is included in a project, the "Export" extension is automatically made available to all the DataGrid controls used in the project.

Using the code

This module exposes two methods:

  • Export (this DataGrid dg) - extends the DataGrid control by providing the export functionality.
  • ExportDataGrid (DataGrid dGrid) - this method is internally called by the "Export" DataGrid extension. However, this method can be directly called too.
C#
public static void Export(this DataGrid dg)
{
    ExportDataGrid(dg);
}
public static void ExportDataGrid(DataGrid dGrid)
{
    SaveFileDialog objSFD = new SaveFileDialog() { DefaultExt = "csv", 
        Filter = "CSV Files (*.csv)|*.csv|Excel XML (*.xml)|*.xml|All files (*.*)|*.*", 
        FilterIndex = 1 };
    if (objSFD.ShowDialog() == true)
    {
        string strFormat = 
          objSFD.SafeFileName.Substring(objSFD.SafeFileName.IndexOf('.') + 1).ToUpper();
        StringBuilder strBuilder = new StringBuilder();
        if (dGrid.ItemsSource == null) return;
        List<string> lstFields = new List<string>();
        if (dGrid.HeadersVisibility == DataGridHeadersVisibility.Column || 
            dGrid.HeadersVisibility == DataGridHeadersVisibility.All)
        {
            foreach (DataGridColumn dgcol in dGrid.Columns)
                lstFields.Add(FormatField(dgcol.Header.ToString(), strFormat));
            BuildStringOfRow(strBuilder, lstFields, strFormat);
        }
        foreach (object data in dGrid.ItemsSource)
        {
            lstFields.Clear();
            foreach (DataGridColumn col in dGrid.Columns)
            {
                string strValue = "";                    
                Binding objBinding = null;
                if (col is DataGridBoundColumn)
                    objBinding = (col as DataGridBoundColumn).Binding;
                if (col is DataGridTemplateColumn)
                {
                    //This is a template column...
                    //    let us see the underlying dependency object
                    DependencyObject objDO = 
                      (col as DataGridTemplateColumn).CellTemplate.LoadContent();
                    FrameworkElement oFE = (FrameworkElement)objDO;
                    FieldInfo oFI = oFE.GetType().GetField("TextProperty");
                    if (oFI != null)
                    {
                        if (oFI.GetValue(null) != null)
                        {
                            if (oFE.GetBindingExpression(
                                   (DependencyProperty)oFI.GetValue(null)) != null)
                                objBinding = 
                                  oFE.GetBindingExpression(
                                  (DependencyProperty)oFI.GetValue(null)).ParentBinding;
                        }
                    }
                }
                if (objBinding != null)
                {
                    if (objBinding.Path.Path != "")
                    {
                        PropertyInfo pi = data.GetType().GetProperty(objBinding.Path.Path);
                        if (pi != null) strValue = pi.GetValue(data, null).ToString();
                    }
                    if (objBinding.Converter != null)
                    {
                        if (strValue != "")
                            strValue = objBinding.Converter.Convert(strValue, 
                              typeof(string), objBinding.ConverterParameter, 
                              objBinding.ConverterCulture).ToString();
                        else
                            strValue = objBinding.Converter.Convert(data, 
                              typeof(string), objBinding.ConverterParameter, 
                              objBinding.ConverterCulture).ToString();
                    }
                }
                lstFields.Add(FormatField(strValue,strFormat));
            }
            BuildStringOfRow(strBuilder, lstFields, strFormat);
        }
        StreamWriter sw = new StreamWriter(objSFD.OpenFile());
        if (strFormat == "XML")
        {
            //Let us write the headers for the Excel XML
            sw.WriteLine("<?xml version=\"1.0\" " + 
                         "encoding=\"utf-8\"?>");
            sw.WriteLine("<?mso-application progid" + 
                         "=\"Excel.Sheet\"?>");
            sw.WriteLine("<Workbook xmlns=\"urn:" + 
                         "schemas-microsoft-com:office:spreadsheet\">");
            sw.WriteLine("<DocumentProperties " + 
                         "xmlns=\"urn:schemas-microsoft-com:" + 
                         "office:office\">");
            sw.WriteLine("<Author>Arasu Elango</Author>");
            sw.WriteLine("<Created>" +  
                         DateTime.Now.ToLocalTime().ToLongDateString() + 
                         "</Created>");
            sw.WriteLine("<LastSaved>" + 
                         DateTime.Now.ToLocalTime().ToLongDateString() + 
                         "</LastSaved>");
            sw.WriteLine("<Company>Atom8 IT Solutions (P) " + 
                         "Ltd.,</Company>");
            sw.WriteLine("<Version>12.00</Version>");
            sw.WriteLine("</DocumentProperties>");
            sw.WriteLine("<Worksheet ss:Name=\"Silverlight Export\" " + 
               "xmlns:ss=\"urn:schemas-microsoft-com:office:spreadsheet\">");
            sw.WriteLine("<Table>");
        }
        sw.Write(strBuilder.ToString());
        if (strFormat == "XML")
        {
            sw.WriteLine("</Table>");
            sw.WriteLine("</Worksheet>");
            sw.WriteLine("</Workbook>");
        }
        sw.Close();
    }
}

The ExportDataGrid method prompts to the user to select the output save file name. Based on the user selection, the method determines the format to save -- XML or CSV. The Excel XML format used is not compatible with Microsoft Excel 2003 or earlier.

The row contents are built by a method named BuildStringOfRow.

C#
private static void BuildStringOfRow(StringBuilder strBuilder, 
        List<string> lstFields, string strFormat)
{
    switch (strFormat)
    {
        case "XML":
            strBuilder.AppendLine("<Row>");
            strBuilder.AppendLine(String.Join("\r\n", lstFields.ToArray()));
            strBuilder.AppendLine("</Row>");
            break;
        case "CSV":
            strBuilder.AppendLine(String.Join(",", lstFields.ToArray()));
            break;
    }
}

The above method builds the row contents string as per the output format. Formatting of individual fields is done by a method named FormatField.

C#
private static string FormatField(string data, string format)
{
    switch (format)
    {
        case "XML":
            return String.Format("<Cell><Data ss:Type=\"String" + 
               "\">{0}</Data></Cell>", data);
        case "CSV":
            return String.Format("\"{0}\"", 
              data.Replace("\"", "\"\"\"").Replace("\n", 
              "").Replace("\r", ""));
    }
    return data;
}

The FormatField method returns the data formatted as per the output format.

How to use

After including the attached code (DataGridExtensions.cs) to your project, you can initiate the export of the DataGrid contents by calling the Export() method of the DataGrid. For example, if the DataGrid name is objDataGrid, you will be calling objDataGrid.Export() to invoke the export.

Points of interest

This code generates the Excel file in XML format. I found exporting in XML much easier than exporting into the XLS or XLSX format.

History

  • Version 1 - December 1, 2009.

License

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


Written By
Architect Atom8 IT Solutions (P) Ltd
India India
I have been programming since 1991. I consider programming as my passion. I founded Atom8 IT Solutions (P) Ltd., in April 2009 and have been developing applications in Microsoft Technologies (mainly C#, Silverlight).

My specialization has been on the US healthcare domain (Medical Transcription, Patient Financial Services, EMRs).

Comments and Discussions

 
GeneralMy vote of 5 Pin
Member 47608858-Dec-10 21:51
Member 47608858-Dec-10 21:51 
GeneralGreat sample but fails Pin
dwf200824-Nov-10 6:53
dwf200824-Nov-10 6:53 
GeneralRe: Great sample but fails Pin
raelango24-Nov-10 22:38
raelango24-Nov-10 22:38 
GeneralMy vote of 5 Pin
mcaayyappan23-Sep-10 1:18
mcaayyappan23-Sep-10 1:18 
GeneralPlease advise... [modified] Pin
AlexWang201021-Sep-10 12:00
AlexWang201021-Sep-10 12:00 
GeneralHi Pin
Naga Sridhar Madiraju29-Aug-10 22:41
Naga Sridhar Madiraju29-Aug-10 22:41 
Questiondatagrid with datapager Pin
uscgc72410-Aug-10 8:52
uscgc72410-Aug-10 8:52 
AnswerRe: datagrid with datapager Pin
livinho3818-Aug-10 0:30
livinho3818-Aug-10 0:30 
i have the same problem,
have you found a solution?
GeneralRe: datagrid with datapager Pin
raelango18-Aug-10 0:56
raelango18-Aug-10 0:56 
GeneralRe: datagrid with datapager Pin
uscgc7248-Sep-10 5:43
uscgc7248-Sep-10 5:43 
AnswerRe: datagrid with datapager Pin
lakson25-Dec-10 3:05
lakson25-Dec-10 3:05 
GeneralOutstanding! One comment to handle NULL values in data... Pin
Noah Wollowick21-Jul-10 14:41
Noah Wollowick21-Jul-10 14:41 
Questionwhich version of SL is this example? Pin
zondymothoa13-Jun-10 22:49
zondymothoa13-Jun-10 22:49 
AnswerRe: which version of SL is this example? Pin
raelango13-Jun-10 23:24
raelango13-Jun-10 23:24 
GeneralReplacing escape characters Pin
seonsoo25-May-10 23:54
seonsoo25-May-10 23:54 
GeneralOutstanding! Pin
David_Murdoch30-Apr-10 13:24
David_Murdoch30-Apr-10 13:24 
GeneralRe: Outstanding! Pin
raelango30-Apr-10 22:03
raelango30-Apr-10 22:03 
Generalnice work dude Pin
sachinblore27-Apr-10 8:52
sachinblore27-Apr-10 8:52 
Generalno me graba la informacion en los controles Pin
ccmmasi22-Apr-10 13:16
ccmmasi22-Apr-10 13:16 
GeneralRe: no me graba la informacion en los controles Pin
raelango22-Apr-10 21:28
raelango22-Apr-10 21:28 
GeneralException if datacell is null Pin
francesconuma2-Mar-10 1:46
francesconuma2-Mar-10 1:46 
GeneralRe: Exception if datacell is null Pin
raelango2-Mar-10 2:38
raelango2-Mar-10 2:38 
QuestionCan the file be give a name in code? Pin
2 Rocks17-Feb-10 9:08
2 Rocks17-Feb-10 9:08 
AnswerRe: Can the file be give a name in code? Pin
raelango17-Feb-10 19:28
raelango17-Feb-10 19:28 
Generalcan't work when the datagrid is binded to a dataview. Pin
Member 1467027-Jan-10 17:46
Member 1467027-Jan-10 17:46 

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.