VSTO - Excel C# - C# Solution -VSTO Development Solutions

Creating Your First VSTO Add-in for Excel

Prerequisites:

Visual Studio 2015 or above having Microsoft Office for Developer Tool installed
Create Excel Addin in C# or VB code style (Visual Studio Tools for Office)

To create a new Excel VSTO Add-in project in Visual Studio follow the steps:

Start Visual Studio.
On the File menu, point to New, and then click Project.
In the templates pane, expand Visual C# or Visual Basic, and then expand Office/SharePoint.
Under the expanded Office/SharePoint node, select the Office Add-ins node.
In the list of project templates, select Excel 2010 Add-in or Excel 2013 Add-in.
In the Name box, type FirstAddIn.
Click OK.

Visual Studio creates the First Excel AddIn project and opens the ThisAddIn.cs code file in the editor:

This class provides an entry point for your code and provides access to the object model of Excel. For more information, see Programming VSTO Add-Ins. The remainder of the ThisAddIn class is defined in a hidden code file that you should not modify.
The ThisAddIn_Startup and ThisAddIn_Shutdown event handlers. These event handlers are called when Excel loads and unloads your VSTO Add-in. Use these event handlers to initialize your VSTO Add-in when it is loaded, and to clean up resources used by your Add-in when it is unloaded. For more information, see Events in Office Projects.

Let’s add a line of text to the saved workbook. In the ThisAddIn.cs code file, add the following code to the This Add In class. The new code defines an event handler for the Work book Before Save event, which is raised when a workbook is saved

C# code example:

void Application_WorkbookBeforeSave(Microsoft. Office. Interop. Excel.Workbook Wb, bool Save As UI, ref bool Cancel)
{
	//get reference of active sheet
	Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet);
	//get A1 range
	Excel.Range firstRow = activeWorksheet.get_Range("A1");
	//insert one row below
	firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown);
	//Take firstRow range
	Excel.Range newFirstRow = activeWorksheet.get_Range("A1");
	//added text to range
	newFirstRow.Value2 = "This text was added by using code";
}

VB code example:

Private Sub Application_WorkbookBeforeSave(ByVal Wb As Microsoft.Office.Interop.Excel.Workbook, ByVal SaveAsUI As Boolean, ByRef Cancel As Boolean) Handles Application.WorkbookBeforeSave
	'taking reference of active sheet
	Dim activeWorksheet As Excel.Worksheet = CType(Application.ActiveSheet, Excel.Worksheet)
	'Take range of A1 cell
	Dim firstRow As Excel.Range = activeWorksheet.Range("A1")
	'Inserting one row down
	firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown)
	'take the range back
	Dim newFirstRow As Excel.Range = activeWorksheet.Range("A1")
	'put the value
	newFirstRow.Value2 = "This text was added by using code"

End Sub

Event declaration: If you are using C#, add the following required code to the ThisAddIn_Startup event handler. This code is used to connect the Application_WorkbookBeforeSave event handler with the WorkbookBeforeSave event:

this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);

To modify the workbook when it is saved, the previous code examples use the following objects:

The Application field of the ThisAddIn class. The Application field returns a Microsoft.Office.Interop.Excel.Application object, which represents the current instance of Excel.
The Wb parameter of the event handler for the WorkbookBeforeSave event. The Wb parameter is a Microsoft.Office.Interop.Excel.Workbook object, which represents the saved workbook. For more information, see Excel Object Model Overview.

Run Project:

Press F5 to build and run your project.
When you build the project, the code is compiled into an assembly that is included in the build output folder for the project. Visual Studio also creates a set of registry entries that enable Excel to discover and load the VSTO Add-in, and it configures the security settings on the development computer to enable the VSTO Add-in to run. For more information, see Building Office Solutions.
In Excel, save the workbook.
Verify that the following text is added to the workbook.
This text was added by using code.
Close Excel.

Next >> Accessing the Object Model of the Host Application

Export Generic Collection to PDF ASP.Net Core MVC

PDF Sometime you may in need to export data in PDF. Following code will use Syncfusion Package and give you ready made Table pushed from Generic collection. Put below code in Repository Put below code in Controller JavaScript Code Finally you can attach id to an element in html and in JavaScript on Document ready […]

Export Excel ASP.Net Core MVC

Excel Export Following Example helps you to export excel from database in a generic way using EPPlus library. Requirement EPPlus Nuget Package Code to Repository Supporting Method Code to Controller Code to JavaScript JavaScript Supporting Method You can hit ExportToExcel() call in document ready method in JavaScript document by pointing any id written in HTML […]

Save/Retrieve Session ASP.Net Core MVC

Session Plays a vital role while dealing with caching in your browser. ASP.Net Core offers Session caching fast and reliable way. Here is the practical example. Put following code anywhere in common class or Repository, it has two methods Generic in nature Add/Get. Add Method will allow you to cache object in Browser memory and […]

Number List in Word Document using C# code example

Number List Microsoft Word offers feature by which you can auto number your list in various formats. In this article we will write code to dynamically generate a numbered list in a document using C#. C# Code example Note: You have to add Microsoft Word Interop library as reference to enable Using statement or create […]

Sorting in Microsoft Word using VBA (Visual Basic for Applications)

Sorting Do you know, Microsoft Word has capability to perform sorting over a document. In this article we will write code to sort paragraphs in Alphabetical order using visual basic for applications code. Before code Code example Put above code in a module, Select number of paragraphs that you would like to sort in A-Z […]

EPPlus Open Office Xml Office solution using C#

EPPlus Is an open Office XML solution, highly useful library capable to manipulate Microsoft Excel similar to Introp APIs. Why EPPlus? As per Microsoft the solutions (Excel, Word, PowerPoint, Outlook etc) built for client architecture but what about Servers? Let’s take an example that I have recently faced and EPPlus helped me a lot here. […]

String vs StringBuilder C#.Net with code example

String C# class which offers capability to store any type of string data into a variable. Strings are immutable (non-modifiable) cause performance overhead because each time we modify a string it creates a copy of modified instance into the memory, hence, as a practice string should be avoided for large string operations. Following is the […]

Var vs. Dynamic C# with code example

Var vs. Dynamic C# offers variety with flavors to accomplish the task to the developers. var keyword defines a static nature which gets resolve at compile-time introduced in C# 3.0 where dynamic gets resolved at runtime introduced in C# 4.0. Var is a statically type variable, which means values of these variables gets decoded at […]

Multi-threading in C#.Net with step by step code example

Multi-threading Is a concept to execute multiple tasks or process simultaneously. Basically multi-threading enables paths to your application to execute multiple processes. Multi-threading can be achieved in C# using System.Threading name space which provides complete control over threading. Let’s write example code where we will execute two different methods to print numbers using loop and […]

Create a progress bar in Excel using VBA (Visual Basic for Applications)

Progress bar In this article we will create one progress bar using Excel vba with step by step example. User can change feel and look of the UserForm as per their need and mimic the logic to fit in their solution. Design Insert a user form Add one label on it and change Caption property […]

VSTO (Visual Studio Tools for Office)

Creating Your First VSTO Add-in for Excel

RSS feed

Subscribe to our articles