Develop Office Add-ins
Develop task pane, content, and mail add-ins to extend Office applications.
Last modified: August 31, 2015
Applies to: Access apps for SharePoint | apps for Office | Excel | Office Add-ins | Outlook | PowerPoint | Project | Word
Learn more about supported hosts and other requirements.
The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.
The typical development lifecycle of a content, mail, or task pane add-in project involves the following processes:
Decide on the purpose of the add-in.
Ask the following questions:
How is the add-in useful?
How does it help your customers be more productive?
What scenarios does your add-in's features support?
Decide the most important features and scenarios and focus your design around them.
Identify the data and data source for the add-in.
Is the data in a document, workbook, presentation, project, or an Access browser-based database, or about an item or items in an Exchange Server or Exchange Online mailbox? Is the data from an external source such as a web service?
Identify the type of add-in and Office host applications that best support the purpose of the add-in.
Consider the following to identify the scenarios:
Will customers use the add-in to enrich the content of a document or Access browser-based database? If so, you may want to consider creating a content add-in. Currently, you can create content add-ins for Access, Excel, Excel Online, PowerPoint, or PowerPoint Online.
Will customers use the add-in while viewing or composing an email message or appointment? Is being able to expose the add-in according to the current context important? Is making the add-in available on not just the desktop, but also on tablets and smartphones a priority?
If you answer yes to any of these questions, consider creating a mail add-in. Currently, you can create mail add-ins for the Outlook rich clients, Outlook Web App and OWA for Devices, if your mailbox resides on an Exchange Server. Then identify the context that will trigger your add-in (for example, the user being in a compose form, specific message types, the presence of an attachment, address, task suggestion, or meeting suggestion, or certain string patterns in the contents of an email or appointment). See Activate mail add-ins in Outlook clients to find out how you can contextually activate the mail add-in.
Will customers use the add-in to enhance the viewing or authoring experience of a document? If so, you may want to consider creating a task pane add-in. Currently, you can create task pane add-ins for Excel, Excel Online, PowerPoint, PowerPoint Online, Project, and Word.
Design and implement the user experience and user interface for the add-in.
Design a fast and fluid user experience that is consistent, easy to learn, with primary scenarios that require only a few steps to complete. Depending on the purpose of the add-in, make use of third party APIs or web services.
Create an XML manifest file based on the Office Add-ins manifest schema.
You can specify the context, based on the current message or appointment, under which your add-in is relevant and you would like Outlook to make it available for use in the user interface. You should also decide the devices that you want the add-in to support. In the manifest, specify the context as activation rules and the supported devices.
Install and test the add-in.
Install the mail add-in into an Exchange mailbox, and specify the location of the add-in manifest file in the Exchange Admin Center (EAC). For more information about installing mail add-ins, see Deploy and install mail add-ins for testing in Outlook.
See the following topics for more information about testing and debugging mail add-ins:
Publish the add-in.
You can submit the add-in to the Office Store, from which customers can install the add-in. In addition, you can publish task pane and content add-ins to a private folder add-in catalog on SharePoint or to a shared network folder, and you can deploy a mail add-in directly on an for your organization. For details, see Publish your Office Add-in.
Updating the add-in
Contextual activation for mail add-ins
Designing the user interface
Creating a manifest
Installing and testing
Publishing and licensing