Présentation des compléments Word

Voulez-vous créer une solution qui étend les fonctionnalités de Word ? Par exemple, un qui implique l’assembly de documents automatisé ? Ou une solution qui lie et accède aux données d’un document Word à partir d’autres sources de données ? Vous pouvez utiliser la plateforme de compléments Office, qui inclut l’API JavaScript Word et l’API JavaScript Office, pour étendre Word clients s’exécutant sur un ordinateur de bureau Windows, sur un Mac ou dans le cloud.

Les compléments Word font partie des nombreuses options de développement disponibles sur la plateforme de compléments Office. Vous pouvez utiliser les commandes de complément pour développer l’interface utilisateur Word et créer des volets Office qui exécutent un code JavaScript pour interagir avec le contenu d’un document Word. Tout code que vous pouvez exécuter dans un navigateur peut s’exécuter dans un complément Word. Les compléments qui interagissent avec le contenu d’un document Word créent des requêtes qui agissent sur des objets Word et synchronisent l’état des objets.

Remarque

Si vous prévoyez de publier votre complément sur AppSource et de le rendre disponible dans l’expérience Office, assurez-vous que vous respectez les politiques de certification du marché commercial.  Par exemple, pour réussir la validation, votre complément doit fonctionner sur toutes les plateformes qui prennent en charge les méthodes que vous définissez (pour en savoir plus, consultez la section 1120.3 et la page relative à la disponibilité et à l’application des compléments Office).

La figure suivante montre un exemple d’un complément Word qui s’exécute dans un volet des tâches.

Figure 1. Complément exécuté dans un volet Office de Word

Complément exécuté dans un volet Office de Word.

Le complément Word peut effectuer les opérations suivantes :

  1. Envoyer des demandes au document Word.
  2. Utilisez JavaScript pour accéder à l’objet de paragraphe et mettre à jour, supprimer ou déplacer le paragraphe.

Par exemple, le code suivant montre comment ajouter une nouvelle phrase à ce paragraphe.

await Word.run(async (context) => {
    const paragraphs = context.document.getSelection().paragraphs;
    paragraphs.load();
    await context.sync();
    paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                       Word.InsertLocation.end);
    await context.sync();
});

Vous pouvez utiliser n’importe quelle technologie de serveur web pour héberger votre complément Word, comme ASP.NET, NodeJS ou Python. Utilisez votre infrastructure côté client préférée (Ember, Backbone, Angular, React) ou utilisez la vanille ou le code JavaScript brut pour développer votre solution. Vous pouvez également utiliser des services comme Azure pour authentifier et héberger votre application.

Les interfaces API JavaScript pour Word permettent à votre application d’accéder aux objets et aux métadonnées situés dans le document Word. Vous pouvez utiliser ces API pour créer des compléments destinés à :

  • Word 2013 ou version ultérieure sur Windows
  • Word sur le web
  • Word 2016 ou version ultérieure sur Mac
  • Word sur iPad

Écrivez votre complément une seule fois, et il s’exécutera dans toutes les versions de Word sur plusieurs plateformes. Pour plus d’informations, voir Disponibilité des applications clientes Office et de la plateforme pour les compléments Office.

APIs JavaScript pour Word

Vous pouvez utiliser les deux ensembles d’APIs JavaScript pour interagir avec les objets et les métadonnées d’un document Word. Le premier groupe est l’API commune, qui a été introduit dans Office 2013. La plupart des objets dans l’API commune peuvent être utilisés dans des compléments hébergés par deux clients Office ou plus. Cette API utilise largement les rappels.

Le deuxième est l’API JavaScript pour Word. Il s’agit d’un modèle d’API spécifique à l’application qui a été introduit avec Word 2016. Il s’agit d’un modèle objet fortement typé que vous pouvez utiliser pour créer Word compléments qui ciblent Word 2016 et versions ultérieures sur Mac et sur Windows. Ce modèle objet utilise des promesses et fournit l’accès à des objets spécifiques à Word tels que le corps, les contrôles de contenu, les images insérées et les paragraphes. L’API JavaScript pour Word inclut les définitions TypeScript et les fichiers vsdoc pour vous permettre d’obtenir des conseils concernant votre code dans votre IDE.

Actuellement, tous les clients Word prennent en charge l’API JavaScript Office partagée, et la plupart des clients prennent en charge l’API JavaScript pour Word. Pour plus d’informations sur les clients pris en charge, voir Disponibilité des applications clientes Office et des plateformes pour les compléments Office.

Nous vous recommandons de démarrer avec l’API JavaScript pour Word car le modèle d’objet est plus facile à utiliser. Utilisez l’API JavaScript Word si vous devez effectuer les opérations suivantes :

  • Accéder aux objets d’un document Word.

Utilisez l’API JavaScript Office partagée lorsque vous devez effectuer l’une des opérations suivantes :

  • Cibler Word 2013.
  • Effectuer des actions initiales pour l’application.
  • Vérifier l’ensemble de conditions requises pris en charge.
  • Accéder aux métadonnées, aux paramètres et aux informations de l’environnement du document.
  • Établir des liaisons avec des sections d’un document et capturer les événements.
  • Ouvrir une boîte de dialogue.

Étapes suivantes

Prêt à créer votre premier complément Word ? Consultez la page Création de votre premier complément Word. Utilisez le manifeste de complément pour décrire l’emplacement d’hébergement de votre complément, sa façon d’afficher et définir des autorisations et d’autres informations.

Pour en savoir plus sur la conception d’un complément Word de classe mondiale qui crée une expérience attrayante pour vos utilisateurs, consultez Recommandations de conception et meilleures pratiques.

Une fois le développement de votre complément terminé, vous pouvez le publier sur un partage réseau, dans un catalogue d’applications ou dans AppSource.

Voir aussi