{"id":702,"date":"2016-10-26T00:00:00","date_gmt":"2016-10-26T08:00:00","guid":{"rendered":"http:\/\/officedevblogs.wpengine.com\/?p=702"},"modified":"2016-10-26T00:00:00","modified_gmt":"2016-10-26T08:00:00","slug":"make-your-add-ins-available-in-the-office-ribbon","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/make-your-add-ins-available-in-the-office-ribbon\/","title":{"rendered":"Use commands to make your add-ins available in the Office ribbon"},"content":{"rendered":"<div id=\"body-content\">\n<p>In March 2016, we released <a href=\"http:\/\/dev.office.com\/docs\/add-ins\/design\/add-in-commands\">add-in commands<\/a> for Word, Excel, and PowerPoint for Office desktop and Office Online. Add-in commands were made available in Outlook in November 2015&nbsp;&nbsp;. Commands enable you to extend the Office UI across multiple platforms. We have seen that users are more likely to continue to use add-ins that have command entry points in the Office ribbon, so using add-in commands can increase the retention rate for your add-ins.&nbsp;&nbsp;&nbsp;&nbsp;<\/p>\n<p>In this post, we highlight some of the important <strong>benefits <\/strong>that commands introduce, as well <strong>changes we are making to Office Store policies <\/strong>to require the use of commands in Word, Excel, and PowerPoint add-ins. We are also announcing the deprecation of the custom pane extension point in Outlook add-ins.&nbsp;<\/p>\n<h2><\/h2>\n<h2>Benefit: Integration with the Office UI<\/h2>\n<p style=\"text-align: left\">Add-in commands allow you to extend the Office UI to add custom buttons to the Office ribbon. You can extend existing tabs, create your own custom tab, or extend contextual menus. To see add-in commands in action, watch the <a href=\"https:\/\/channel9.msdn.com\/events\/Build\/2016\/P551\">Add-in commands in the Office ribbon video<\/a>.<\/p>\n<p style=\"text-align: left\">The following are some examples of add-ins that use commands.<\/p>\n<p style=\"text-align: left\"><img decoding=\"async\" width=\"275\" height=\"113\" alt=\"\" src=\"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-content\/uploads\/sites\/73\/2018\/05\/image201a.png\"><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><\/span><\/p>\n<p><span><\/span><\/p>\n<p><span>Figure 1. Boomerang <\/span><span>&nbsp;<\/span><span>add-in extending the Message tab in Outlook<\/span><\/p>\n<p align=\"center\"><span><\/span><\/p>\n<p align=\"center\"><span><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><img decoding=\"async\" width=\"285\" height=\"240\" alt=\"\" src=\"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-content\/uploads\/sites\/73\/2018\/05\/image201.png\"><\/span><\/p>\n<p><span>Figure 2. Pickit add-in command in the Office ribbon<\/span><\/p>\n<p><span><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><img decoding=\"async\" width=\"646\" height=\"139\" alt=\"\" src=\"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-content\/uploads\/sites\/73\/2018\/05\/image3.png\"><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><\/span><\/p>\n<p><span>Figure 3. XLSTAT add-in custom tab<\/span><\/p>\n<p align=\"center\"><span><\/span><\/p>\n<p align=\"center\" style=\"text-align: left\"><span><\/span><\/p>\n<h2>Benefit: Increased discoverability and retention<\/h2>\n<p>Users expect to be able to find all the tools and actions that they need on the Office ribbon. When you adopt commands, you make it easier for users to access and use your add-in. By using commands, you can:<\/p>\n<ul>\n<li>Make your add-in more <strong>discoverable <\/strong>by placing add-in buttons with relevant user flows.<\/li>\n<li>Make your add-in more <strong>efficient<\/strong> to use by making specific actions accessible on the ribbon.<\/li>\n<li>Provide a <strong>familiar <\/strong>experience for users, and increase user <strong>retention<\/strong>, by extending the Office suite. Users will be more likely to come back to use your add-in again.<\/li>\n<\/ul>\n<p>To give you an example of the positive impact that we&rsquo;ve seen so far, several Outlook add-ins had <strong>doubled retention rates<\/strong> after they were updated to use commands. &nbsp;&nbsp;We are seeing a similar positive impact across add-ins for other applications.<\/p>\n<p>\n<h2>Benefit: Teaching UI<\/h2>\n<p>The teaching UI feature is currently rolling out and will be fully deployed in a couple of weeks. You can use teaching UI to show users where an add-in is installed and how to get started using an add-in when they install it from the Office Store. The following is an example of an add-in that uses teaching UI.<\/p>\n<p><p><img decoding=\"async\" width=\"399\" height=\"310\" alt=\"\" src=\"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-content\/uploads\/sites\/73\/2018\/05\/Image203a.png\"><\/p>\n<p style=\"text-align: center\">\n<p><h2>Benefit: Support across multiple platforms<\/h2>\n<p>Add-in commands for Outlook are already supported for Outlook 2013 and Outlook 2016 desktop, and will be supported in Outlook for Mac and Office Online within the next two months. Add-in commands for Word, Excel, and PowerPoint are currently supported&nbsp;&nbsp; in Word, Excel, and PowerPoint in Office 2016 desktop clients and Office Online, and will soon be supported in Office for Mac. For the latest support information for this and other features, see <a href=\"http:\/\/dev.office.com\/add-in-availability\">Office Add-in host and platform availability<\/a>.&nbsp;&nbsp;<\/p>\n<p>Does that mean that you need to wait until commands are supported everywhere to use them in your add-in? Not at all. Today you can create an add-in, with a <strong>single manifest<\/strong> and a single submission to the Office Store (if you are distributing via the Store), that <strong>targets all the Office platforms that support Office Add-ins<\/strong>. Clients that do not support commands, such as Office 2013, will run your add-in as a task pane.<\/p>\n<h2><\/h2>\n<h2>Benefit: Creating commands is easy<\/h2>\n<p>It only takes a few minutes to add commands to your add-in.<\/p>\n<p>If you are creating a new add-in, you can start from one of our existing <a href=\"https:\/\/github.com\/officedev\/office-Add-in-Commands-Samples\">samples<\/a>. If you are a Visual Studio developer, you can use the <a href=\"https:\/\/www.visualstudio.com\/en-us\/features\/office-tools-vs.aspx\">Office Developer Tools<\/a><span style=\"text-decoration: underline\">.<\/span> The Office Web Add-in templates include a sample command.<\/p>\n<p>If you have an existing Outlook or task pane &nbsp;&nbsp;add-in, add a <a href=\"https:\/\/dev.office.com\/reference\/add-ins\/manifest\/versionoverrides\">VersionOverrides<\/a> node to your manifest. You can start by adding a button to launch your task pane. You can also go a step further and re-envision your add-in to take advantage of ribbon integration. For more information, see <a href=\"https:\/\/dev.office.com\/docs\/add-ins\/overview\/add-in-development-best-practices#use-add-in-commands\">best practices for using add-in commands<\/a>.<\/p>\n<p>If you run into issues, see our <a href=\"https:\/\/github.com\/OfficeDev\/Office-Add-in-Commands-Samples\/blob\/master\/FAQ.md\">FAQs<\/a> for help with troubleshooting. You can also post questions to <a href=\"http:\/\/stackoverflow.com\/questions\/tagged\/office-js\">StackOverflow<\/a> and tag with [office-js]. &nbsp;<\/p>\n<h2><\/h2>\n<h2>Requirement: New Office store policies and deprecated features<\/h2>\n<h3>Word, Excel, and PowerPoint add-ins<\/h3>\n<p><strong>Effective February 1, 2017, <\/strong>Word, Excel, and PowerPoint <strong>add-ins that use the taskpane manifest<\/strong> <strong>must use add-in commands in order to pass Office Store validation<\/strong>. This policy will apply to both new submissions and updates to existing Office Store add-ins.<\/p>\n<p>If you need to request an exception to this requirement, indicate the reason for the exception in the testing notes field when you submit your add-in.<\/p>\n<h3>Outlook add-ins<\/h3>\n<p>Add-in commands are already required for all Outlook add-ins in the Office Store. We are also announcing that custom panes in Outlook <strong>will no longer be supported as of February 1, 2017<\/strong>. This applies across all platforms.<\/p>\n<p>Add-in commands provide a significant advantage in terms of user engagement and discoverability over the legacy custom pane experience (shown in the following image).<\/p>\n<p>\n<p><img decoding=\"async\" width=\"653\" height=\"453\" alt=\"\" src=\"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-content\/uploads\/sites\/73\/2018\/05\/image4.png\"><\/p>\n<p>\n<p>Effective November 7, 2016, Outlook add-ins submitted to the Office Store must not declare the CustomPane extension point in the VersionOverrides node&nbsp;. This applies to both new submissions and updates to existing Office Store add-ins. This means less work for you as a developer because you don&rsquo;t have to include an unnecessary extension point if you already have commands.<\/p>\n<h2><\/h2>\n<h2>Call to action<\/h2>\n<p>We encourage you to <strong>adopt commands in your add-in as soon as possible<\/strong>. You will see higher adoption and retention rates and more satisfied users. The following are the effective dates for the Office Store requirements&nbsp;:<\/p>\n<ul>\n<li>New and updated Word, Excel, and PowerPoint add-ins using the taskpane manifest must use commands to pass Office Store validation effective <strong>February 1, 2017<\/strong>.<\/li>\n<li>Outlook add-ins that do not support commands will be removed from the Office Store effective <strong>February 1, 2017<\/strong>.<\/li>\n<li>New and updated Outlook add-ins in the Office Store must not include the CustomPane extension point in the VersionOverrides node effective <strong>November 7, 2016<\/strong>.<\/li>\n<\/ul><\/div>\n","protected":false},"excerpt":{"rendered":"<p>In March 2016, we released add-in commands for Word, Excel, and PowerPoint for Office desktop and Office Online. Add-in commands were made available in Outlook in November 2015&nbsp;&nbsp;. Commands<\/p>\n","protected":false},"author":69076,"featured_media":703,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[11],"tags":[18,12],"class_list":["post-702","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-office-add-ins","tag-excel","tag-outlook"],"acf":[],"blog_post_summary":"<p>In March 2016, we released add-in commands for Word, Excel, and PowerPoint for Office desktop and Office Online. Add-in commands were made available in Outlook in November 2015&nbsp;&nbsp;. Commands<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/702","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/users\/69076"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/comments?post=702"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/posts\/702\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media\/703"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/media?parent=702"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/categories?post=702"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/wp-json\/wp\/v2\/tags?post=702"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}