Partager via

Créer des projets de complément Office à l’aide du Kit de développement de compléments Office pour Visual Studio Code

  • Article

Le Kit de développement des compléments Office permet de configurer votre environnement, de créer des compléments Office et de déboguer votre code dans une expérience simplifiée.

Importante

L’extension Kit de développement des compléments Office prend uniquement en charge la création de compléments qui utilisent le manifeste du complément uniquement. Il crée également uniquement des compléments Excel, PowerPoint et Word pour l’instant. La prise en charge d’Outlook est en cours de développement, tout comme des exemples supplémentaires et d’autres améliorations. Nous vous invitons à nous faire part de vos commentaires sur l’outil. Les demandes de problèmes et de fonctionnalités doivent être envoyées via des problèmes GitHub sur le dépôt de l’extension.

Configuration requise

Installer le kit de développement

Vous pouvez installer le Kit de développement de compléments Office à l’aide des extensions dans Visual Studio Code ou l’installer à partir de la Place de marché Visual Studio Code.

  1. Lancez Visual Studio Code.
  2. Sélectionnez Afficher les>extensions ou Ctrl+Maj+X. Vous pouvez également ouvrir des extensions en sélectionnant l’onglet Extensions dans la barre d’activité Visual Studio Code.
  3. Entrez Le Kit de développement des compléments Office dans la zone de recherche.
  4. Sélectionnez Kit de développement des compléments Office. Dans la page d’extension du Kit de développement des compléments Office qui s’affiche dans le volet main, sélectionnez Installer. Une fois l’installation réussie, l’icône du Kit de développement des compléments Office s’affiche dans la barre d’activité Visual Studio Code.

Création d’un projet de complément

Le Kit de développement des compléments Office offre deux façons de démarrer avec un nouveau projet : des modèles et des exemples. Les modèles vous permettent de choisir l’application Office, le langage de programmation et la fonctionnalité de départ. Les exemples sont des projets plus complets qui illustrent un scénario réaliste.

Créer un complément à partir d’un modèle

Les modèles offrent un point de départ de base pour votre complément. Ils ajoutent une quantité minimale de fonctionnalités afin que vous puissiez commencer sans modifier une grande partie du code existant. Les instructions suivantes décrivent comment créer un nouveau projet à partir d’un modèle à l’aide du kit de développement.

  1. Ouvrez Visual Studio Code et sélectionnez l’icône Kit de développement des compléments Office dans la barre d’activités.
  2. Sélectionnez Créer un nouveau complément dans le volet Office de l’extension.
  3. Dans le menu Choix rapide maintenant actif, sélectionnez l’application Office pour votre complément.
  4. Sélectionnez un modèle de complément dans la liste des modèles disponibles.
  5. Sélectionnez « JavaScript » ou « TypeScript » comme langage de programmation.
  6. Dans la boîte de dialogue Dossier de l’espace de travail qui s’ouvre, sélectionnez le dossier dans lequel vous souhaitez créer le projet.
  7. Donnez un nom au projet (sans espace) lorsque vous y êtes invité. Le Kit de développement des compléments Office crée le projet avec des fichiers de base et une structure automatique. Il ouvre ensuite le projet dans une deuxième fenêtre Visual Studio Code. Vous pouvez fermer librement la fenêtre Visual Studio Code d’origine.

Créer un complément à partir d’un exemple

Les exemples montrent un complément opérationnel qui résout un scénario de bout en bout. Les exemples sont particulièrement utiles en tant qu’outils d’apprentissage pour comprendre comment les fonctionnalités de l’infrastructure des compléments Office fonctionnent ensemble. Vous pouvez également développer un exemple en fonction de vos besoins particuliers.

  1. Ouvrez Visual Studio Code et sélectionnez l’icône Kit de développement des compléments Office dans la barre d’activités.
  2. Sélectionnez Afficher les exemples.
  3. Sélectionnez l’exemple que vous souhaitez afficher.
  4. Sélectionnez le bouton Créer au-dessus de l’exemple lisez-moi maintenant ouvert.
  5. Dans la boîte de dialogue Dossier de l’espace de travail qui s’ouvre, sélectionnez le dossier dans lequel vous souhaitez créer le projet. L’extension copie une version de l’exemple dans ce dossier. Il ouvre ensuite le projet dans une deuxième fenêtre Visual Studio Code. Vous pouvez fermer librement la fenêtre Visual Studio Code d’origine.

Tester votre complément

Pour comprendre comment le complément fonctionne dans une application Office, utilisez le Kit de développement des compléments Office pour exécuter et déboguer votre complément Office dans votre environnement de développement local.

Remarque

Ces étapes sont les mêmes que celles répertoriées dans Visual Studio Code par l’extension lorsque vous créez un projet.

  1. Ouvrez l’extension en sélectionnant l’icône Kit de développement des compléments Office dans la barre d’activités.
  2. Sélectionnez Aperçu de votre complément Office (F5)
  3. Dans le menu Choix rapide, sélectionnez l’option {Application Office} Bureau (Edge Chromium), où « {Application Office} » est l’application appropriée, telle que « Excel » ou « Word ». Cette opération lance le complément et débogue le code.

Le kit de développement vérifie que les conditions préalables sont remplies avant le démarrage du débogage. Consultez le terminal pour obtenir des informations détaillées en cas de problèmes liés à votre environnement. Après ce processus, l’application de bureau Office lance et charge la version test du complément. Notez que l’installation des dépendances peut prendre quelques minutes lors de la première exécution d’un projet. Vous devez installer le certificat lorsque vous y êtes invité.

Arrêter le test de votre complément Office

Une fois que vous avez terminé de tester et de déboguer le complément, fermez-le toujours en procédant comme suit. (La fermeture de l’application Office ou de la fenêtre du serveur web n’annule pas de manière fiable l’inscription du complément.)

  1. Ouvrez l’extension en sélectionnant l’icône Kit de développement des compléments Office dans la barre d’activités.
  2. Sélectionnez Arrêter l’aperçu de votre complément Office. Cela ferme le serveur web et supprime le complément du Registre et du cache.
  3. Fermez la fenêtre d’application Office.

Résolution des problèmes

Si vous rencontrez des problèmes lors de l’exécution du complément, procédez comme suit.

  • Fermez toutes les instances ouvertes d’Office.
  • Fermez le serveur web précédent démarré pour le complément avec l’option Arrêter l’aperçu de l’extension Kit de développement des compléments Office.

L’article Résoudre les erreurs de développement avec les compléments Office contient des solutions aux problèmes courants. Si vous rencontrez toujours des problèmes, créez un problème GitHub et nous vous aiderons.

Pour plus d’informations sur l’exécution du complément sur Office sur le Web, consultez Charger une version test des compléments Office pour Office sur le Web.

Pour plus d’informations sur le débogage sur les versions antérieures d’Office, voir Déboguer des compléments à l’aide d’outils de développement dans Version antérieure de Microsoft Edge.