Assemblies in the Visual Studio Tools for Office runtime

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

When you create an Office project, Visual Studio automatically adds references to the Visual Studio Tools for Office runtime assemblies that are used for the project type and the target .NET Framework of the project. There are different assemblies in the Office extensions for the .NET Framework 3.5, .NET Framework 4, and .NET Framework 4.5. For more information about the Office extensions, see Visual Studio Tools for Office runtime overview.

Assemblies in the Office extensions for the .NET Framework 4 and the .NET Framework 4.5

The following table lists the assemblies that are included in Office extensions for the .NET Framework 4 and the .NET Framework 4.5. For documentation about the namespaces and types in these assemblies, see Managed reference (Office development in Visual Studio).

Assembly name Description
Microsoft.Office.Tools.Common.dll Provides the following types:

- Types for creating Ribbon customizations and smart tags. Note: Smart tags are deprecated in Excel 2010 and Word 2010.
- Types for creating actions panes in document-level customizations and custom task panes in VSTO Add-Ins.
Microsoft.Office.Tools.Excel.dll Provides interfaces that represent host items and host controls for Excel projects, and supporting types. For more information, see Automate Excel by using extended objects.
Microsoft.Office.Tools.Outlook.dll Provides types that you can use to create custom form regions in Outlook VSTO Add-ins.
Microsoft.Office.Tools.Word.dll Provides interfaces that represent host items and host controls for Word projects, and supporting types. For more information, see Automate Word by using extended objects.
Microsoft.Office.Tools.v4.0.Framework.dll Provides the following types:

- Exceptions that can be thrown by the Visual Studio Tools for Office runtime.
- Attributes you can use when creating Outlook form regions.
Microsoft.Office.Tools.dll Provides types that are part of the Visual Studio Tools for Office runtime infrastructure, and are not intended to be used directly from your code.
Microsoft.VisualStudio.Tools.Applications.Runtime.dll Provides the following types:

- The CachedAttribute attribute and ICachedType interface, which you can use to cache data objects in a document-level customization. For more information, see Cache data.
- The IAddInPostDeploymentAction interface, which you can implement to run additional installation steps as the final step of the ClickOnce installer for an Office solution. For more information, see Deploy an Office solution by using ClickOnce.
- Exceptions that can be thrown by the Visual Studio Tools for Office runtime.
- Other types that are part of the Visual Studio Tools for Office runtime infrastructure, and are not intended to be used directly from your code.
Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll Provides the following types:

- The ServerDocument class, which you can use to attach customization assemblies to documents and to access the cached data in documents. For more information, see Manage documents on a server by using the ServerDocument class.
- Several classes that represent the hierarchy of cached data in a document-level customization. For more information, see Access data in documents on the server.

Projects that target the .NET Framework 4 or the .NET Framework 4.5 also reference the following assemblies. These assemblies are not part of the Visual Studio Tools for Office runtime redistributable. Instead, they are dependent assemblies that must be deployed with your solution. By default, they are copied to the build output folder for your project (the Copy Local property for these assemblies are set to True). If you deploy your project by using ClickOnce, these assemblies are included in the generated package.

Assembly name Description
Microsoft.Office.Tools.Common.v4.0.Utilities.dll Provides the base classes for the generated ThisAddIn class in VSTO Add-In projects and the generated Ribbon class in all projects.
Microsoft.Office.Tools.Excel.v4.0.Utilities.dll Provides the following types:

- Base classes for the generated ThisWorkbook and Sheet classes in document-level projects for Excel.
- Windows Forms controls that you can use on worksheets in Excel projects.
Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll Provides base classes for the generated ThisAddIn and form region classes in Outlook projects.
Microsoft.Office.Tools.Word.v4.0.Utilities.dll Provides the following types:

- Base classes for the generated ThisDocument class in document-level projects for Word.
- Windows Forms controls that you can use on documents in Word projects.

Assemblies in the Office extensions for the .NET Framework 3.5

The following table lists the assemblies that are included in the Office extensions for the .NET Framework 3.5. For documentation about the namespaces and classes in these assemblies, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Assembly name Description
Microsoft.Office.Tools.Common.v9.0.dll Provides the following types:

- The Microsoft.Office.Tools.AddIn base class for VSTO Add-ins.
- Classes for creating Ribbon customizations and smart tags. Note: Smart tags are deprecated in Excel 2010 and Word 2010.
- Classes for creating actions panes in document-level customizations and custom task panes in VSTO Add-ins.
Microsoft.Office.Tools.Excel.v9.0.dll Provides host items and host controls for Excel solutions. For more information, see Automate Excel by using extended objects.
Microsoft.Office.Tools.Outlook.v9.0.dll Provides classes that you can use to create custom form regions in Outlook VSTO Add-ins.
Microsoft.Office.Tools.Word.v9.0.dll Provides host items and host controls for Word solutions. For more information, see Automate Word by using extended objects.
Microsoft.Office.Tools.v9.0.dll Provides the following types:

- The RemoteBindableComponent class, which provides the data binding capabilities for host controls in document-level customizations.
- Other types that are part of the Visual Studio Tools for Office runtime infrastructure, and are not intended to be used directly from your code.
Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll Provides the following types:

- The CachedAttribute attribute and ICachedType interface, which you can use to cache data objects in a document-level customization. For more information, see Cache data.
- Exceptions that can be thrown by the Visual Studio Tools for Office runtime.
- Other types that are part of the Visual Studio Tools for Office runtime infrastructure, and are not intended to be used directly from your code.
Microsoft.VisualStudio.Tools.Applications.Runtime.v10.0.dll Provides the IAddInPostDeploymentAction interface, which you can implement to run additional installation steps as the final step of the ClickOnce installer for an Office solution. For more information, see Advanced Office solution deployment.
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll Provides the following types:

- The ServerDocument class, which you can use to programmatically attach customization assemblies to documents and to access the cached data in documents. For more information, see Manage documents on a server by using the ServerDocument class.
- Several classes that represent the hierarchy of cached data in a document-level customization. For more information, see Access data in documents on the server.
Microsoft.VisualStudio.Tools.Office.Runtime.v10.0.dll Provides the following types:

- The Microsoft.VisualStudio.Tools.Office.Runtime.Security.AddInSecurityEntry and Microsoft.VisualStudio.Tools.Office.Runtime.Security.UserInclusionList classes, which you can use to create user inclusion list entries to grant trust to Office solutions that target the .NET Framework 3.5.
- Other types that are part of the Visual Studio Tools for Office runtime infrastructure, and are not intended to be used directly from your code.

See also