Ouvrir automatiquement un volet Office avec un document

Vous pouvez utiliser des commandes de complément dans votre complément Office pour étendre l’interface utilisateur Office en ajoutant des boutons au ruban de l’application Office. Lorsque les utilisateurs cliquent sur le bouton de commande, une action est réalisée, comme l’ouverture d’un volet des tâches.

Certains scénarios nécessitent qu’un volet des tâches s’ouvre automatiquement quand un document s’ouvre, sans intervention explicite de l’utilisateur. Vous pouvez utiliser la fonctionnalité de volet Office d’ouverture automatique, introduite dans l’ensemble de conditions requises AddInCommands 1.1, pour ouvrir automatiquement un volet Office lorsque votre scénario l’exige.

En quoi la fonctionnalité d’ouverture automatique est-elle différente de l’insertion d’un volet des tâches ?

Lorsqu’un utilisateur lance des compléments qui n’utilisent pas de commandes de complément, les compléments sont insérés dans le document et sont conservés dans ce document. Par conséquent, lorsque d’autres utilisateurs ouvrent le document, ils sont invités à installer le complément et le volet Office s’ouvre. La difficulté de ce modèle est que, dans de nombreux cas, les utilisateurs ne souhaitent pas que le complément soit conservé dans le document. Par exemple, un étudiant qui utilise un complément de dictionnaire dans un document Word ne voudra peut-être pas que ses camarades de classe ou enseignants soient invités à installer ce complément lorsqu’ils ouvrent le document.

Avec la fonctionnalité d’ouverture automatique, vous pouvez explicitement définir ou autoriser l’utilisateur à déterminer si un complément de volet des tâches spécifique est conservé dans un document spécifique.

Prise en charge et disponibilité

La fonctionnalité d’ouverture automatique est actuellement prise en charge dans les produits et plateformes suivants.

Meilleures pratiques

Appliquez les meilleures pratiques suivantes lorsque vous utilisez la fonctionnalité d’ouverture automatique.

• Utilisez la fonctionnalité d’ouverture automatique quand elle vous aide à rendre vos utilisateurs de complément plus efficaces, comme dans les cas suivants :

  • Lorsque le document a besoin du complément pour fonctionner correctement. Par exemple, une feuille de calcul qui contient des valeurs de stock régulièrement actualisées par un complément. Le complément doit s’ouvrir automatiquement lorsque la feuille de calcul est ouverte pour maintenir les valeurs à jour.
  • Lorsque l’utilisateur sera le plus susceptible d’utiliser le complément avec un document particulier. Par exemple, un complément qui permet aux utilisateurs de renseigner ou de modifier des données dans un document en extrayant des informations à partir d’un système principal.

• Autorisez les utilisateurs à activer ou à désactiver la fonctionnalité d’ouverture automatique. Incluez une option dans votre interface utilisateur pour choisir de ne plus ouvrir automatiquement le volet des tâches de complément.

• Utilisez la détection de l’ensemble de conditions requises pour déterminer si la fonctionnalité d’ouverture automatique est disponible et fournir un comportement de secours si ce n’est pas le cas.

• N’utilisez pas la fonctionnalité d’ouverture automatique pour augmenter artificiellement l’utilisation de votre complément. S’il n’est pas judicieux que votre complément s’ouvre automatiquement avec certains documents, cette fonctionnalité peut gêner les utilisateurs.

  Remarque

  Si Microsoft détecte un abus de la fonctionnalité d’ouverture automatique, votre complément peut être rejeté d’AppSource.

• N’utilisez pas cette fonctionnalité pour épingler plusieurs volets de tâches. Vous pouvez uniquement définir l’ouverture automatique d’un volet de votre complément avec un document.

Implémenter la fonctionnalité d’ouverture automatique

• Spécifiez le volet des tâches à ouvrir automatiquement.
• Ajoutez des balises au document pour ouvrir automatiquement le volet des tâches.

Étape 1 : Spécifier le volet des tâches à ouvrir

Pour spécifier le volet de tâches à ouvrir automatiquement, définissez la valeur TaskpaneId sur Office.AutoShowTaskpaneWithDocument. Vous pouvez uniquement définir cette valeur sur un seul volet de tâches. Si vous définissez cette valeur sur plusieurs volets de tâches, la première occurrence de la valeur sera reconnue et les autres seront ignorées.

L’exemple suivant illustre la valeur TaskPaneId définie sur Office.AutoShowTaskpaneWithDocument.

<Action xsi:type="ShowTaskpane">
    <TaskpaneId>Office.AutoShowTaskpaneWithDocument</TaskpaneId>
    <SourceLocation resid="Contoso.Taskpane.Url" />
</Action>

Étape 2 : Baliser le document pour ouvrir automatiquement le volet de tâches

Vous pouvez baliser le document pour déclencher la fonctionnalité d’ouverture automatique de deux façons possibles. Choisissez l’alternative qui convient le mieux à votre scénario.

Baliser le document côté client

Utilisez la méthode Office.js settings.set pour définir Office.AutoShowTaskpaneWithDocument sur true, comme illustré dans l’exemple suivant.

Office.context.document.settings.set("Office.AutoShowTaskpaneWithDocument", true);
Office.context.document.settings.saveAsync();

Utilisez cette méthode si vous devez baliser le document dans le cadre de vos interactions de complément (par exemple, dès que l’utilisateur crée une liaison ou choisit une option pour indiquer qu’il souhaite que le volet s’ouvre automatiquement).

Utiliser Open XML pour baliser le document

Vous pouvez utiliser Open XML pour créer ou modifier un document et ajouter le balisage Open Office XML approprié afin de déclencher la fonctionnalité d’ouverture automatique. Pour obtenir un exemple montrant comment procéder, voir Office-OOXML-EmbedAddin.

Ajoutez deux parties Open XML au document.

• Un composant webextension
• Un composant taskpane

L’exemple suivant montre comment ajouter le composant webextension.

<we:webextension xmlns:we="http://schemas.microsoft.com/office/webextensions/webextension/2010/11" id="[ADD-IN ID PER MANIFEST]">
  <we:reference id="[GUID or AppSource asset ID]" version="[your add-in version]" store="[Pointer to store or catalog]" storeType="[Store or catalog type]"/>
  <we:alternateReferences/>
  <we:properties>
   <we:property name="Office.AutoShowTaskpaneWithDocument" value="true"/>
  </we:properties>
  <we:bindings/>
  <we:snapshot xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"/>
</we:webextension>

Le composant webextension inclut un conteneur de propriétés et une propriété nommée Office.AutoShowTaskpaneWithDocument qui doit être définie sur true.

Le composant webextension comprend également une référence au store ou au catalogue avec des attributs pour id, storeType, store et version. Parmi les valeurs storeType, uniquement quatre sont pertinentes pour la fonctionnalité d’ouverture automatique. Les valeurs pour les trois autres attributs dépendent de la valeur pour storeType, comme illustré dans le tableau suivant.

Pour plus d’informations sur le balisage webextension, reportez-vous à [MS-OWEXML] 2.2.5. WebExtensionReference.

L’exemple suivant montre comment ajouter le composant taskpane.

<wetp:taskpane dockstate="right" visibility="0" width="350" row="4" xmlns:wetp="http://schemas.microsoft.com/office/webextensions/taskpanes/2010/11">
  <wetp:webextensionref xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" r:id="rId1" />
</wetp:taskpane>

Notez que dans cet exemple, l’attribut visibility est défini sur « 0 ». Ainsi, après l’ajout des composants taskpane et du volet de tâches, l’utilisateur doit installer le complément via le bouton Complément sur le ruban lorsqu’il ouvre le document pour la première fois. Par la suite, le volet de tâches de complément s’ouvre automatiquement lorsque le fichier est ouvert. En outre, lorsque vous définissez visibility sur « 0 », vous pouvez utiliser Office.js pour autoriser les utilisateurs à activer ou à désactiver la fonctionnalité d’ouverture automatique. Plus spécifiquement, le script définit le paramètre de document Office.AutoShowTaskpaneWithDocument sur true ou false. (Pour plus d’informations, voir Baliser le document côté client.)

Si visibility est défini sur « 1 », le volet Office s’ouvre automatiquement la première fois que le document est ouvert. L’utilisateur est invité à approuver le complément, et lorsque l’approbation est accordée, le complément s’ouvre. Par la suite, le volet de tâches de complément s’ouvre automatiquement lorsque le fichier est ouvert. Toutefois, lorsque visibility est défini sur « 1 », vous ne pouvez pas utiliser Office.js pour permettre aux utilisateurs d’activer ou de désactiver la fonctionnalité d’ouverture automatique.

Définir visibility sur « 1 » est un bon choix lorsque le complément et le modèle ou contenu du document sont tellement étroitement intégrés que l’utilisateur ne choisirait pas de désactiver la fonctionnalité d’ouverture automatique.

Un moyen simple d’écrire le code XML consiste d’abord à exécuter votre complément et à baliser le document côté client pour écrire la valeur, puis à enregistrer le document et à inspecter le code XML généré. Office détecte et fournit les valeurs d’attribut appropriées. Vous pouvez également utiliser l’outil de productivité du Kit de développement logiciel (SDK) Open XML pour générer du code C# afin d’ajouter par programmation le balisage basé sur le code XML que vous générez.

Tester et vérifier l’ouverture des volets Office

Vous pouvez déployer une version de test de votre complément qui ouvre automatiquement un volet Office à l’aide du déploiement centralisé via le Centre d’administration Microsoft 365. L’exemple suivant montre la façon dont les compléments sont insérés à partir du catalogue de déploiement centralisé à l’aide de la version store d’EXCatalog.

<we:webextension xmlns:we="http://schemas.microsoft.com/office/webextensions/webextension/2010/11" id="{52811C31-4593-43B8-A697-EB873422D156}">
    <we:reference id="af8fa5ba-4010-4bcc-9e03-a91ddadf6dd3" version="1.0.0.0" store="EXCatalog" storeType="EXCatalog"/>
    <we:alternateReferences/>
    <we:properties/>
    <we:bindings/>
    <we:snapshot xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"/>
</we:webextension>

Vous pouvez tester l’exemple précédent en utilisant votre abonnement Microsoft 365 pour tester le déploiement centralisé et vérifier que votre complément fonctionne comme prévu. Si vous n’avez pas encore d’abonnement Microsoft 365, vous pouvez bénéficier d’un abonnement Microsoft 365 E5 développeur par le biais du Programme pour les développeurs Microsoft 365. Pour plus d’informations, consultez le FAQ. Vous pouvez également vous inscrire à un essai gratuit de 1 mois ou acheter un plan Microsoft 365.

Voir aussi

• Pour obtenir un exemple qui montre comment utiliser la fonctionnalité d’ouverture automatique, consultez Ouvrir automatiquement un volet Office avec un document.
• Ouvrir automatiquement un volet Office lors de l’installation d’un complément
• Découvrez le programme pour les développeurs Microsoft 365