Compréhension de l’API JavaScript pour Office

  • Article

Un complément Office peut utiliser l’API JavaScript Office pour interagir avec le contenu du document Office dans lequel le complément est exécuté.

Accès à la bibliothèque de l’API JavaScript Office

La bibliothèque de l’interface API JavaScript Office est accessible via le réseau de distribution de contenu (CDN) d’Office JS à l’adresse suivante : https://appsforoffice.microsoft.com/lib/1/hosted/office.js. Pour utiliser les API JavaScript Office dans les pages web de votre complément, vous devez référencer le réseau de distribution de contenu dans une balise <script>dans la balise <head> de la page.

<head>
    ...
    <script src="https://appsforoffice.microsoft.com/lib/1/hosted/office.js" type="text/javascript"></script>
</head>

Remarque

Pour utiliser les API destinées à la prévisualisation, référencez la version d’évaluation de la bibliothèque de l’interface API JavaScript Office dans le CDN : https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Si vous souhaitez en savoir plus sur l’accès à la bibliothèque de l’interface API JavaScript pour Office, notamment sur l’obtention d’IntelliSense, consultez Référencement de la bibliothèque de l’interface API JavaScript pour Office à partir de son réseau de distribution de contenu (CDN).

Modèles API

L’API JavaScript pour Office inclut deux modèles distincts :

  • Les API propres à l’application fournissent des objets fortement typés qui peuvent être utilisés pour interagir avec des objets natifs d’une application Office spécifique. Par exemple, vous pouvez utiliser les API JavaScript pour Excel pour accéder à des feuilles de calcul, plages, tableaux, graphiques, etc. Les API spécifiques à l’application sont actuellement disponibles pour les applications Office suivantes.

    Ce modèle d’API utilise des promesses et vous permet de spécifier plusieurs opérations dans chaque demande que vous envoyez à l’application Office. Les opérations de traitement par lots de cette manière peuvent améliorer sensiblement les performances des compléments dans les applications Office sur le Web. Des API spécifiques à l’application ont été introduites avec Office 2016.

    Remarque

    Il existe également une API spécifique à l’application pour Visio, mais vous pouvez l’utiliser uniquement dans les pages SharePoint Online pour interagir avec les diagrammes Visio qui ont été incorporés dans la page. Les compléments web Office ne sont pas pris en charge dans Visio.

    Visitez Utilisation du modèle API propre à l’application pour en savoir plus sur ce modèle d’API.

  • Les API Communes peuvent être utilisées pour accéder à des fonctionnalités telles qu’une interface utilisateur, des boîtes de dialogue et des paramètres du client, qui sont communes à plusieurs types d’applications Office. Ce modèle d’API utilise desrappels, qui vous permettent de spécifier une seule opération dans chaque demande envoyée à l’application Office. Les API courantes ont été introduites avec Office 2013 et peuvent être utilisées pour interagir avec toutes les applications Office prises en charge. Si vous souhaitez plus en savoir sur le modèle objet API commun, qui inclut des API pour l’interaction avec Outlook et PowerPoint, veuillez consulter Modèle d’objet API JavaScript communes.

Remarque

Les fonctions personnalisées sans runtime partagé s’exécutent dans un runtime JavaScript uniquement qui hiérarchise l’exécution des calculs. Ces fonctions utilisent un modèle de programmation légèrement différent et sont appelées fonctions sans interface utilisateur.

Ensembles de conditions requises de l’API

Les ensembles de conditions requises sont des groupes nommés de membres d’API. Les ensembles de conditions requises peuvent être spécifiques aux applications Office, telles que l’ ExcelApi 1.7 ensemble de conditions requises ( un ensemble d’API qui ne peut être utilisé que dans Excel), ou communs aux applications multiples, telles que l’ DialogApi 1.1 ensemble de conditions requises (un ensemble d’API qui peut être utilisé dans n’importe quelle application Office qui prend en charge l’API Dialogue).

Votre complément peut utiliser des ensembles de conditions requises pour déterminer si l’application Office prend en charge les membres d’API nécessaires. Pour plus d’informations à ce sujet, consultez les applications Office Spécifier et les conditions requises d’API.

La prise en charge de l’ensemble des conditions requises varie selon l’application, la version et la plateforme d’Office. Pour plus d’informations sur les plateformes, les ensembles de conditions requises et les API communes prises en charge par chaque application Office, consultez la rubrique Disponibilité de la plateforme et de l’application cliente pour les compléments Office.

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).

Voir aussi