{"id":10398,"date":"2022-05-10T12:16:25","date_gmt":"2022-05-10T19:16:25","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/?p=10398"},"modified":"2022-08-04T16:36:48","modified_gmt":"2022-08-04T23:36:48","slug":"announcing-changes-to-office-add-ins-executefunction-commands","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/microsoft365dev\/announcing-changes-to-office-add-ins-executefunction-commands\/","title":{"rendered":"Announcing changes to Office Add-ins’ ExecuteFunction commands"},"content":{"rendered":"

Office Add-ins have long supported custom ribbon buttons and menus, called add-in commands. For Word, Excel, PowerPoint, and Outlook, these come in two flavors: those that open a task pane and those that call a JavaScript function. For the latter ExecuteFunction<\/strong> type of command, you create a function in a JavaScript file and then identify the function by name in the manifest. The JavaScript file is loaded by a UI-less HTML file, usually called functionfile.html or commands.html.<\/span><\/p>\n

To improve security in Office Add-ins, we are changing how you create ExecuteFunction<\/strong> add-in commands. <\/span>This change does not require re-submission of your Office Add-in.<\/span><\/p>\n

In addition to defining the JavaScript function, you also need to register the function with Office by adding a call of Office.actions.associate(\"name-of-function\", function)<\/code>.<\/span><\/p>\n

Office.actions.associate(\"name-of-function\", function)<\/pre>\n
Office Add-ins ExecuteFunction code sample<\/span><\/h2>\n
function writeText(event) {\r\n    \/\/ Implement your custom code here. The following code is a simple example.   \r\n    Office.context.document.setSelectedDataAsync(\"ExecuteFunction works. Button ID=\" + event.source.id,\r\n        function(asyncResult) {\r\n            var error = asyncResult.error;\r\n            if (asyncResult.status === Office.AsyncResultStatus.Failed) {\r\n                \/\/ Show error message. \r\n            } else {\r\n                \/\/ Show success message. \r\n            }\r\n        });\r\n    \/\/ Calling event.completed is required. event.completed lets the platform know that processing has completed. \r\n    event.completed();\r\n}\r\n\/\/ Register the function with the associate API \r\nOffice.actions.associate(\"writeText\", writeText);\r\n<\/code><\/pre>\n
<\/i>IMPORTANT<\/strong><\/p>You must make these changes before October 30, 2022. On that date, functions in the ExecuteFunction<\/strong> type add-in commands that are not registered in this way will no longer run. So, lease update your Office Add-in as soon as possible to avoid impacting your add-ins functionality. <\/div><\/p>\n
To test that you\u2019ve correctly registered your functions, you can simulate how Office will behave on October 30, 2022. Add an attribute to the <script> tag that loads the Office JavaScript library in the HTML file. The following is an example:\n<\/span><\/p>\n
[html]\r\n<script src=\"https:\/\/appsforoffice.microsoft.com\/lib\/1\/hosted\/office.js\" data-use-associated-actions-only=\"1\" type=\"text\/javascript\"><\/script>\r\n[html]<\/pre>\n
When you load the Office JavaScript library with the data-use-associated-actions-only attribute, registered add-in commands will run. Add-in commands that you do not register with the associated API, will not.<\/span><\/p>\n
 <\/p>\n
Additional resources<\/h3>\n