Walkthrough: Creating Your First Application-Level Add-in for Word
Updated: July 2008
The information in this topic applies only to the specified Visual Studio Tools for Office projects and versions of Microsoft Office.
Microsoft Office version
For more information, see Features Available by Application and Project Type.
This introductory walkthrough shows you how to create an application-level add-in for Microsoft Office Word. The features that you create in this kind of solution are available to the application itself, regardless of which documents are open.
This walkthrough illustrates the following tasks:
Creating a Word add-in project for Word 2003 or Word 2007.
Writing code that uses the object model of Word to add text to a document when it is saved.
Building and running the project to test it.
Cleaning up the completed project so that the add-in no longer runs automatically on your development computer.
Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. The Visual Studio edition that you have and the settings that you use determine these elements. For more information, see Visual Studio Settings.
You need the following components to complete this walkthrough:
Visual Studio Tools for Office (an optional component of Visual Studio 2008 Professional and Visual Studio Team System).
Word 2003 or Word 2007.
By default, Visual Studio Tools for Office is installed with the listed versions of Visual Studio. To check whether it is installed on your computer, see Installing Visual Studio Tools for Office.
To create a new Word add-in project in Visual Studio
Start Visual Studio.
On the File menu, point to New, and then click Project.
In the Project Types pane, expand Visual C# or Visual Basic, and then expand Office.
Select the 2007 folder if you are developing a Word 2007 add-in, or select the 2003 folder if you are developing a Word 2003 add-in.
In the Templates pane, select Word 2003 Add-in or Word 2007 Add-in.
In the Name box, type FirstWordAddIn.
Visual Studio creates the FirstWordAddIn project and opens the ThisAddIn code file in the editor.
Next, add code to the ThisAddIn code file. The new code uses the object model of Word to add boilerplate text to each saved document. By default, the ThisAddIn code file contains the following generated code:
A partial definition of the ThisAddIn class. This class provides an entry point for your code and provides access to the object model of Word. For more information, see AddIn Host Item. 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 Word loads and unloads your add-in. Use these event handlers to initialize your add-in when it is loaded, and to clean up resources used by your add-in when it is unloaded. For more information, see Visual Studio Tools for Office Project Events.
To add a paragraph of text to the saved document
In the ThisAddIn code file, add the following code to the ThisAddIn class. The new code defines an event handler for the DocumentBeforeSave event, which is raised when a document is saved.
When the user saves a document, the event handler adds new text at the start of the document.
This code uses an index value of 1 to access the first paragraph in the Paragraphs collection. Although Visual Basic and Visual C# use 0-based arrays, the lower array bounds of most collections in the Word object model is 1. For more information, see Programming with Visual Basic vs. C# in Office Solutions.
If you are using C#, add the following required code to the ThisAddIn_Startup event handler. This code is used to connect the Application_DocumentBeforeSave event handler with the DocumentBeforeSave event.
To modify the document when it is saved, the previous code examples use the following objects:
The Application field of the ThisAddIn class. The Application field returns a Application object, which represents the current instance of Word.
The Doc parameter of the event handler for the DocumentBeforeSave event. The Doc parameter is a Document object, which represents the saved document. For more information, see Word Object Model Overview.
To test the 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 Word to discover and load the add-in, and it configures the security settings on the development computer to enable the add-in to run. For more information, see Office Solution Build Process Overview.
In Word, save the active document.
Verify that the following text is added to the document.
This text was added by using code.
When you finish developing a project, remove the add-in assembly, registry entries, and security settings from your development computer. Otherwise, the add-in will continue to run every time that you open Word on your development computer.
To clean up the completed project on your development computer
In Visual Studio, on the Build menu, click Clean Solution.
Now that you have created a basic application-level add-in for Word, you can learn more about how to develop add-ins from these topics:
General programming tasks that you can perform in add-ins: Programming Application-Level Add-Ins.
Programming tasks that are specific to Word add-ins: Word Application-Level Add-in Development.
Using the object model of Word: Word Object Model Overview.
Customizing the UI of Word, for example, by adding a custom tab to the Ribbon or creating your own custom task pane: Office UI Customization.
Building and debugging application-level add-ins for Word: Building and Debugging Office Solutions.
Deploying application-level add-ins for Word: Deploying Office Solutions.