How do you databind a DataSet to an Excel Worksheet from a VSTO Plugin?

Posted on 2008-09-30
Last Modified: 2013-12-17
I am pretty sure that the key is a listObject but I cannot figure out how to create one in code.

Here is my Setup:
Visual Studios 2008
Visual Studio Template: Excel 2007 Addin
Code Executed from a UserControl.

So far I have the code calling a webservice and returning a DataSet. I have the populated dataset but cannot get the data from that dataset into the active worksheet.

I have seen a few examples of how to do this but all of them seem to be from a different project type (Excel 2007 workbook from what I can tell) and the same commands do not seem to be available.

If someone could show me some sample code of a Dataset being bound in someway to an excel worksheet it would be greatly appreciated.
Question by:docstar
1 Comment

Accepted Solution

docstar earned 0 total points
ID: 22609592
Got It, finally after a full day researching just this one item:

Attached is the slightly modified version for those having a simular issue:
/// <summary>

        /// Submits Report and populates Excel with the results.

        /// All parameters should have been validated prior to calling this method.

        /// </summary>

        private void SubmitReport()




                ReportService.ASGReportsServiceClient sc = new ExcelReportPlugin.ReportService.ASGReportsServiceClient();

                ReportService.ReturnCode oReturn = new ExcelReportPlugin.ReportService.ReturnCode();

                DataSet ds = sc.ExecuteReport(ut, SelReport, ref oReturn);

                if (oReturn.Result == ExcelReportPlugin.ReportService.Code.cSuccess)


                    //Bind Dataset to the Active Excel Sheet.

                    Microsoft.Office.Interop.Excel.Worksheet worksheet = (Microsoft.Office.Interop.Excel.Worksheet)Globals.ThisAddIn.Application.ActiveSheet;


                    Microsoft.Office.Interop.Excel.Range rng = AddData(ds.Tables[0], worksheet);

                    Addtable(rng, "ThisIsMyTable");                    




                    throw new Exception(oReturn.Description, oReturn.Exception);



            catch (Exception e) { ExceptionHandler(e); }


        /// <summary>

        /// Add data to the sheets, with the columns names at the top 

        /// </summary>

        /// <param name="dataTable">The data to be added to the sheet</param>

        /// <param name="sheetToAddTo">The worksheet to add the data to</param>

        /// <returns>The range of the data that has been added</returns>

        private Microsoft.Office.Interop.Excel.Range AddData(System.Data.DataTable dataTable, Microsoft.Office.Interop.Excel.Worksheet sheetToAddTo)


            //create the object to store the column names

            object[,] columnNames;

            columnNames = new object[1, dataTable.Columns.Count];

            //add the columns names from the datatable

            for (int i = 0; i < dataTable.Columns.Count; i++)


                columnNames[0, i] = dataTable.Columns[i].ColumnName;


            //get a range object that the columns will be added to

            Microsoft.Office.Interop.Excel.Range columnsNamesRange = (Microsoft.Office.Interop.Excel.Range)sheetToAddTo.get_Range(sheetToAddTo.Cells[1, 1]

           , sheetToAddTo.Cells[1, dataTable.Columns.Count]);

            //a simple assignement allows the data to be transferred quickly

            columnsNamesRange.Value2 = columnNames;

            //release the columsn range object now it is finished with

            columnsNamesRange = null;

            //create the object to store the dataTable data

            object[,] rowData;

            rowData = new object[dataTable.Rows.Count, dataTable.Columns.Count];

            //insert the data into the object[,]

            for (int iRow = 0; iRow < dataTable.Rows.Count; iRow++)


                for (int iCol = 0; iCol < dataTable.Columns.Count; iCol++)


                    rowData[iRow, iCol] = dataTable.Rows[iRow][iCol];



            //get a range to add the table data into 

            //it is one row down to avoid the previously added columns

            Microsoft.Office.Interop.Excel.Range dataCells = (Microsoft.Office.Interop.Excel.Range)sheetToAddTo.get_Range(sheetToAddTo.Cells[2, 1],

            sheetToAddTo.Cells[dataTable.Rows.Count + 1, dataTable.Columns.Count]);

            //assign data to worksheet

            dataCells.Value2 = rowData;


            //release range

            dataCells = null;


            //return the range to the new data

            return sheetToAddTo.get_Range(sheetToAddTo.Cells[1, 1],

           sheetToAddTo.Cells[dataTable.Rows.Count + 1, dataTable.Columns.Count]);


        /// <summary>

        /// This function adds a new Excel table 

        /// (with nice formatting and filtering etc) 

        /// to the tableRange passed in. It names the range tableName. 

        /// This will error if tableName is already used.

        /// This function uses XlYesNoGuess.xlYes to 

        /// automatically make the first row the headings.

        /// </summary>

        /// <param name="tableRange">Range to convert to a table</param>

        /// <param name="tableName">Name of new table</param>

        private void Addtable(Microsoft.Office.Interop.Excel.Range tableRange, string tableName)


            Microsoft.Office.Interop.Excel.Worksheet activeSheet = (Microsoft.Office.Interop.Excel.Worksheet)Globals.ThisAddIn.Application.ActiveSheet;

            Microsoft.Office.Interop.Excel.ListObject newList = tableRange.Worksheet.ListObjects.Add(Microsoft.Office.Interop.Excel.XlListObjectSourceType.xlSrcRange, 

                                                                    tableRange,null, Microsoft.Office.Interop.Excel.XlYesNoGuess.xlYes, tableRange);

            newList.Name = tableName;


Open in new window


Featured Post

What Is Threat Intelligence?

Threat intelligence is often discussed, but rarely understood. Starting with a precise definition, along with clear business goals, is essential.

Join & Write a Comment

Recently while returning home from work my wife (another .NET developer) was murmuring something. On further poking she said that she has been assigned a task where she has to serialize and deserialize objects and she is afraid of serialization. Wha…
This document covers how to connect to SQL Server and browse its contents.  It is meant for those new to Visual Studio and/or working with Microsoft SQL Server.  It is not a guide to building SQL Server database connections in your code.  This is mo…
This is Part 3 in a 3-part series on Experts Exchange to discuss error handling in VBA code written for Excel. Part 1 of this series discussed basic error handling code using VBA.…
Polish reports in Access so they look terrific. Take yourself to another level. Equations, Back Color, Alternate Back Color. Write easy VBA Code. Tighten space to use less pages. Launch report from a menu, considering criteria only when it is filled…

707 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

15 Experts available now in Live!

Get 1:1 Help Now