ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel

How To Add a Ribbon to Excel with C# Interop

Updated on March 11, 2012

This is Part 3 of a three part tutorial on creating an Excel SQL Server CRUD application using ADO.NET. You should read Part 1 and Part 2 first.


Add code to load, update and save data back to the data store

In order to save data back to the database I will show you how to implement CRUD operations. To implement this I am going to create a Ribbon and add a button to save the changes that are done to the Excel File back to the database. I will also provide some code to load the data from the database when the application is loaded.

To help you with creating Ribbon in Excel and C#, Check out my other Tutorial on Creating Excel Applications using Ribbon and C# for more ideas and information on Creating Ribbons with C# which provides a detailed walk through on creating ribbons with C#.

To add the ribbon, right-click on the ExcelADO solution and do “Add” -> “New Item”
Select the Data node under Visual C# to filter the available templates.
Select Ribbon (Visual Designer) template. Provide a name for the ribbon and cs code file
Click “ok” to create the ribbon

Add New Ribbon
Add New Ribbon
private void button1_Click(object sender, RibbonControlEventArgs e)
 {
   Globals.Sheet1.projectIdentificationBindingSource.EndEdit();
   Globals.Sheet1.projectIdentificationTableAdapter.Update(Globals.Sheet1.excelDS.ProjectIdentification);
 }

From the Visual Designer, change the name of the Group object to “gtProject” and change the caption to “Projects”
Add a Button from the Toolbox by dragging & dropping from the Ribbon Controls onto to gtProjects group and change the caption to “Save”

Double-click on the button to open the code editor

Navigate to the button1_Click method and add the following code:

The first line signals to the BindingSource that edited has completed. The second line tells tableAdapter to update the DataSet which linked to the database table throught the Data source to perform one of the CRUD operations (Insert, Update or Delete) that I configured in the Data Source section.

using Excel = Microsoft.Office.Interop.Excel;
using ExcelTools = Microsoft.Office.Tools;
.....

private void Project_Load(object sender, RibbonUIEventArgs e)
 {
      Excel.Worksheet worksheet = (Excel.Worksheet)Globals.Sheet1.Application.ActiveWorkbook.Worksheets[1];
      ExcelTools.Excel.Worksheet extendedWorksheet = ExcelTools.Excel.Worksheet.GetVstoObject(worksheet);
  }
Also checkout the code I added to the load method:

You will need to add the following references:

The first line initialises a Microsoft.Office.Interop.Excel worksheet object that points to the first worksheet. This can be any sheet in the workbook. The second line calls the GetVstoObject method of the Microsoft.Office.Tools and passes the active worksheet and automatically loads the data in the DataSet that is linked to the database into the worksheet.

Consclusion

That concludes this tutorial. As you can see it is fairly easy to create a sophisticated CRUD application with Excel and SQL Server using ADO.NET and C#.

Comments

    0 of 8192 characters used
    Post Comment

    • klanguedoc profile imageAUTHOR

      Kevin Languedoc 

      6 years ago from Canada

      Did you install the VSTO feature pack in to Visual Studio?

    • profile image

      the QB 

      6 years ago

      Hi Klan, thanks for the post. I tried all the steps but looks like the last line of code is having a problem.

      "ExcelTools.Excel.Worksheet.GetVstoObject(worksheet);"

      I am getting the error "does not contain a definition for GetVstoObject". I already tried the two using statements:

      using Excel = Microsoft.Office.Interop.Excel;

      using ExcelTools = Microsoft.Office.Tools;

      but that doesn't help. Are you sure there isn't something else needed like "using Microsoft.Office.Tools.Excel.Extensions;" for the vsto method?

    working

    This website uses cookies

    As a user in the EEA, your approval is needed on a few things. To provide a better website experience, hubpages.com uses cookies (and other similar technologies) and may collect, process, and share personal data. Please choose which areas of our service you consent to our doing so.

    For more information on managing or withdrawing consents and how we handle data, visit our Privacy Policy at: https://hubpages.com/privacy-policy#gdpr

    Show Details
    Necessary
    HubPages Device IDThis is used to identify particular browsers or devices when the access the service, and is used for security reasons.
    LoginThis is necessary to sign in to the HubPages Service.
    Google RecaptchaThis is used to prevent bots and spam. (Privacy Policy)
    AkismetThis is used to detect comment spam. (Privacy Policy)
    HubPages Google AnalyticsThis is used to provide data on traffic to our website, all personally identifyable data is anonymized. (Privacy Policy)
    HubPages Traffic PixelThis is used to collect data on traffic to articles and other pages on our site. Unless you are signed in to a HubPages account, all personally identifiable information is anonymized.
    Amazon Web ServicesThis is a cloud services platform that we used to host our service. (Privacy Policy)
    CloudflareThis is a cloud CDN service that we use to efficiently deliver files required for our service to operate such as javascript, cascading style sheets, images, and videos. (Privacy Policy)
    Google Hosted LibrariesJavascript software libraries such as jQuery are loaded at endpoints on the googleapis.com or gstatic.com domains, for performance and efficiency reasons. (Privacy Policy)
    Features
    Google Custom SearchThis is feature allows you to search the site. (Privacy Policy)
    Google MapsSome articles have Google Maps embedded in them. (Privacy Policy)
    Google ChartsThis is used to display charts and graphs on articles and the author center. (Privacy Policy)
    Google AdSense Host APIThis service allows you to sign up for or associate a Google AdSense account with HubPages, so that you can earn money from ads on your articles. No data is shared unless you engage with this feature. (Privacy Policy)
    Google YouTubeSome articles have YouTube videos embedded in them. (Privacy Policy)
    VimeoSome articles have Vimeo videos embedded in them. (Privacy Policy)
    PaypalThis is used for a registered author who enrolls in the HubPages Earnings program and requests to be paid via PayPal. No data is shared with Paypal unless you engage with this feature. (Privacy Policy)
    Facebook LoginYou can use this to streamline signing up for, or signing in to your Hubpages account. No data is shared with Facebook unless you engage with this feature. (Privacy Policy)
    MavenThis supports the Maven widget and search functionality. (Privacy Policy)
    Marketing
    Google AdSenseThis is an ad network. (Privacy Policy)
    Google DoubleClickGoogle provides ad serving technology and runs an ad network. (Privacy Policy)
    Index ExchangeThis is an ad network. (Privacy Policy)
    SovrnThis is an ad network. (Privacy Policy)
    Facebook AdsThis is an ad network. (Privacy Policy)
    Amazon Unified Ad MarketplaceThis is an ad network. (Privacy Policy)
    AppNexusThis is an ad network. (Privacy Policy)
    OpenxThis is an ad network. (Privacy Policy)
    Rubicon ProjectThis is an ad network. (Privacy Policy)
    TripleLiftThis is an ad network. (Privacy Policy)
    Say MediaWe partner with Say Media to deliver ad campaigns on our sites. (Privacy Policy)
    Remarketing PixelsWe may use remarketing pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to advertise the HubPages Service to people that have visited our sites.
    Conversion Tracking PixelsWe may use conversion tracking pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to identify when an advertisement has successfully resulted in the desired action, such as signing up for the HubPages Service or publishing an article on the HubPages Service.
    Statistics
    Author Google AnalyticsThis is used to provide traffic data and reports to the authors of articles on the HubPages Service. (Privacy Policy)
    ComscoreComScore is a media measurement and analytics company providing marketing data and analytics to enterprises, media and advertising agencies, and publishers. Non-consent will result in ComScore only processing obfuscated personal data. (Privacy Policy)
    Amazon Tracking PixelSome articles display amazon products as part of the Amazon Affiliate program, this pixel provides traffic statistics for those products (Privacy Policy)