Word solutions

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Visual Studio provides project templates you can use to create document-level customizations and VSTO Add-ins for Microsoft Office Word. You can use these solutions to automate Word, extend Word features, and customize the Word user interface (UI). For more information about the differences between document-level customizations and VSTO Add-ins, see Office solutions development overview (VSTO).

Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for Word. For more information, see Features available by Office application and project type.

Note

Interested in developing solutions that extend the Office experience across multiple platforms? Check out the new Office Add-ins model. Office Add-ins have a small footprint compared to VSTO Add-ins and solutions, and you can build them by using almost any web programming technology, such as HTML5, JavaScript, CSS3, and XML.

This topic provides the following information:

Automate Word

The Word object model exposes many types that you can use to automate Word. For example, you can programmatically create tables, format documents, and set the text in ranges and paragraphs. For more information, see Word object model overview.

When developing Word solutions in Visual Studio, you can also use host items and host controls in your solutions. These are objects that extend certain commonly used objects in the Word object model, such as the Document and ContentControl objects. The extended objects behave like the Word objects they are based on, but they add additional events and data binding capabilities to the objects. For more information, see Automate Word by using extended objects.

Develop document-level customizations for Word

A document-level customization for Microsoft Office Word consists of an assembly that is associated with a specific document. The assembly typically extends the document by customizing the UI and by automating Word. Unlike a VSTO Add-in, which is associated with Word itself, functionality that you implement in a customization is available only when the associated document is open in Word.

To create a document-level customization project for Word, use the Word Document or Word Template project templates in the New Project dialog box of Visual Studio. For more information, see How to: Create Office projects in Visual Studio.

For more information about how document-level customizations work, Architecture of document-level customizations.

Word customization programming model

When you create a document-level project for Word, Visual Studio generates a class, called ThisDocument, which is the foundation of your solution. This class represents the document that is associated with your solution, and it provides a starting point for writing your code.

For more information about the ThisDocument class and other features you can use in a document-level project, see Program document-level customizations.

Develop VSTO Add-ins for Word

A VSTO Add-in for Microsoft Office Word consists of an assembly that is loaded by Word. The assembly typically extends Word by customizing the UI and by automating Word. Unlike a document-level customization, which is associated with a specific document, functionality that you implement in a VSTO Add-in is not restricted to any single document.

To create a VSTO Add-in project for Word, use the Word Add-in project templates in the New Project dialog box of Visual Studio. For more information, see How to: Create Office projects in Visual Studio.

For general information about how VSTO Add-ins work, see Architecture of VSTO Add-ins.

Word Add-in programming model

When you create a Word VSTO Add-in project, Visual Studio generates a class, called ThisAddIn, which is the foundation of your solution. This class provides a starting point for writing your code, and it also exposes the object model of Word to your VSTO Add-in.

For more information about the ThisAddIn class and other features you can use in a VSTO Add-in, see Program VSTO Add-ins.

Customize the user interface of Word

There are several different ways to customize the user interface of Word. Some options are available to all project types, and other options are available only to VSTO Add-ins or document-level customizations.

Options for all project types

The following table lists customization options that are available to both document-level customizations and VSTO Add-ins.

Task For more information
Customize the Ribbon. Ribbon overview
Add Windows Forms controls or extended Word controls to the customized document (for a document-level customization) or to any open document (for a VSTO Add-in). How to: Add Windows Forms controls to Office documents

How to: Add content controls to Word documents

How to: Add bookmark controls to Word documents

Options for document-level customizations

The following table lists customization options that are available only to document-level customizations.

Task For more information
Add an actions pane to the document. Actions pane overview

How to: Add an actions pane to Word documents or Excel workbooks
Add extended XMLNode and XMLNodes controls to the document surface. How to: Add XMLNode controls to Word documents

How to: Add XMLNodes controls to Word documents

Options for VSTO Add-ins

The following table lists customization options that are available only to VSTO Add-ins.

Task For more information
Create a custom task pane. Custom task panes
Title Description
Word object model overview Provides an overview of the main types provided by the Word object model.
Automate Word by using extended objects Provides information about extended objects (provided by the Visual Studio Tools for Office runtime) that you can use in Word solutions.
Windows Forms controls on Office documents overview Describes how you can add Windows Forms controls to Word documents.
Walkthrough: Create your first document-level customization for Word Demonstrates how to create a basic document-level customization for Word.
Walkthrough: Create your first VSTO Add-in for Word Demonstrates how to create a basic VSTO Add-in for Word.
Walkthrough: Add controls to a document at run time in a VSTO Add-in Demonstrates how to add a Windows Forms button and a RichTextContentControl to a document at run time by using a VSTO Add-in.
Word 2010 in Office development Provides links to articles and reference documentation about developing Word solutions (not specific to Office development using Visual Studio).