Menu
EndNote X7 and X8 CWYW and MS Word 2016 for Mac: Compatibility and Recommendations: EndNote X8 is now available: Buy EndNote X8 today Please also see: Is EndNote X7 or EndNote X8 CWYW compatible with MS Office 365 / MS Word 365? EndNote X7.5 - X7.7.1 or EndNote X8 Windows or Mac: Missing or non-functional CWYW in MS Word 2016: Attention: EndNote X7.7 for Windows and Mac. I am a user of the EndNote Web and recently I have downloaded the Cite While You Write plug-in for Mac. I have the MS Word 2016, but it failed to show the EndNote toolbar.
-->
You can use add-in commands in your Office Add-in to extend the Office UI by adding buttons to the Office ribbon. When users click your command button, an action occurs, such as opening a task pane.
Some scenarios require that a task pane open automatically when a document opens, without explicit user interaction. You can use the autoopen task pane feature, introduced in the AddInCommands 1.1 requirement set, to automatically open a task pane when your scenario requires it.
How is the autoopen feature different from inserting a task pane?
When a user launches add-ins that don't use add-in commands - for example, add-ins that run in Office 2013 - they are inserted into the document, and persist in that document. As a result, when other users open the document, they are prompted to install the add-in, and the task pane opens. The challenge with this model is that in many cases, users don’t want the add-in to persist in the document. For example, a student who uses a dictionary add-in in a Word document might not want their classmates or teachers to be prompted to install that add-in when they open the document.
With the autoopen feature, you can explicitly define or allow the user to define whether a specific task pane add-in persists in a specific document.
Support and availability
The autoopen feature is currently supported in the following products and platforms.
Best practices
Apply the following best practices when you use the autoopen feature:
Implementation
To implement the autoopen feature:
Important
The pane that you designate to open automatically will only open if the add-in is already installed on the user's device. If the user does not have the add-in installed when they open a document, the autoopen feature will not work and the setting will be ignored. If you also require the add-in to be distributed with the document you need to set the visibility property to 1; this can only be done using OpenXML, an example is provided later in this article.
Step 1: Specify the task pane to open
To specify the task pane to open automatically, set the TaskpaneId value to Office.AutoShowTaskpaneWithDocument. You can only set this value on one task pane. If you set this value on multiple task panes, the first occurrence of the value will be recognized and the others will be ignored.
The following example shows the TaskPaneId value set to Office.AutoShowTaskpaneWithDocument.
Step 2: Tag the document to automatically open the task pane
You can tag the document to trigger the autoopen feature in one of two ways. Pick the alternative that works best for your scenario.
Tag the document on the client side
Use the Office.js settings.set method to set Office.AutoShowTaskpaneWithDocument to true, as shown in the following example.
Use this method if you need to tag the document as part of your add-in interaction (for example, as soon as the user creates a binding, or chooses an option to indicate that they want the pane to open automatically).
Use Open XML to tag the document
You can use Open XML to create or modify a document and add the appropriate Open Office XML markup to trigger the autoopen feature. For a sample that shows you how to do this, see Office-OOXML-EmbedAddin.
Add two Open XML parts to the document:
The following example shows how to add the
webextension part.
The
webextension part includes a property bag and a property named Office.AutoShowTaskpaneWithDocument that must be set to true .
The
webextension part also includes a reference to the store or catalog with attributes for id , storeType , store , and version . Of the storeType values, only four are relevant to the autoopen feature. The values for the other three attributes depend on the value for storeType , as shown in the following table.
Note
To find the asset ID and version of an add-in in AppSource, go to the AppSource landing page for the add-in. The asset ID appears in the address bar in the browser. The version is listed in the Details section of the page.
For more information about the webextension markup, see [MS-OWEXML] 2.2.5. WebExtensionReference.
The following example shows how to add the
taskpane part.
Note that in this example, the
visibility attribute is set to '0'. This means that after the webextension and taskpane parts are added, the first time the document is opened, the user has to install the add-in from the Add-in button on the ribbon. Thereafter, the add-in task pane opens automatically when the file is opened. Also, when you set visibility to '0', you can use Office.js to enable users to turn on or turn off the autoopen feature. Specifically, your script sets the Office.AutoShowTaskpaneWithDocument document setting to true or false . (For details, see Tag the document on the client side.)
If
visibility is set to '1', the task pane opens automatically the first time the document is opened. The user is prompted to trust the add-in, and when trust is granted, the add-in opens. Thereafter, the add-in task pane opens automatically when the file is opened. However, when visibility is set to '1', you can't use Office.js to enable users to turn on or turn off the autoopen feature.
Setting
visibility to '1' is a good choice when the add-in and the template or content of the document are so closely integrated that the user would not opt out of the autoopen feature.
Note
If you want to distribute your add-in with the document, so that users are prompted to install it, you must set the visibility property to 1. You can only do this via Open XML.
An easy way to write the XML is to first run your add-in and tag the document on the client side to write the value, and then save the document and inspect the XML that is generated. Office will detect and provide the appropriate attribute values. You can also use the Open XML SDK 2.5 Productivity Tool tool to generate C# code to programmatically add the markup based on the XML you generate.
Test and verify opening task panes
You can deploy a test version of your add-in that will automatically open a task pane using Centralized Deployment via the Office 365 admin center. The following example shows how add-ins are inserted from the Centralized Deployment catalog using the EXCatalog store version.
You can test the previous example by using your Office 365 subscription to try out Centralized Deployment and verify that your add-in works as expected. If you don't already have an Office 365 subscription, you can get a free, 90-day renewable Office 365 subscription by joining the Office 365 Developer Program.
See also
For a sample that shows you how to use the autoopen feature, see Office Add-in commands samples.Join the Office 365 Developer Program.
I can't believe that Endnote is so pathetically not upto date. I have just spent the last three hours trying to get Endnote 7 to work with my Office 2016 only to finally find out that the two are not compatible. Thank you very much.Endnote obviously has absoblutely no value for an individual's time!! It would have been a simple matter of adding a note saying 'Please note that this version of Endnote is not compatible with Micrcosoft Office 2016' under the download tab.!!! Is this that difficult.?!!!
Comments are closed.
|
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
January 2023
Categories |