Procédure pas à pas : Créer votre premier complément VSTO pour Excel

  • Article

Cette procédure pas à pas d'introduction vous indique comment créer un complément de niveau application pour Microsoft Office Excel. Les fonctionnalités que vous créez dans ce type de solution sont accessibles à l'application, quels que soient les classeurs ouverts.

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets de complément VSTO pour Excel. Pour plus d’informations, consultez Fonctionnalités disponibles par application Office lication et le type de projet.

Remarque

Vous souhaitez développer des solutions qui étendent l’expérience de Bureau sur plusieurs plateformes ? Consultez le nouveau modèle de compléments Bureau. Bureau compléments ont une petite empreinte par rapport aux compléments et solutions VSTO, et vous pouvez les créer à l’aide de presque n’importe quelle technologie de programmation web, telle que HTML5, JavaScript, CSS3 et XML.

Cette procédure pas à pas décrit les tâches suivantes :

  • Création d'un projet de complément VSTO Excel pour Excel

  • Écriture de code qui utilise le modèle objet d'Excel pour ajouter du texte à un classeur quand il est enregistré.

  • Génération et exécution du projet pour le tester

  • Nettoyage du projet terminé, pour que le complément VSTO ne s’exécute plus automatiquement sur votre ordinateur de développement

    Remarque

    Il est possible que pour certains des éléments de l'interface utilisateur de Visual Studio, votre ordinateur affiche des noms ou des emplacements différents de ceux indiqués dans les instructions suivantes. L'édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d’informations, consultez Personnaliser l’IDE.

Prérequis

Vous devez disposer des éléments suivants pour exécuter cette procédure pas à pas :

Créer le projet

Pour créer un projet de complément VSTO Excel dans Visual Studio

  1. Démarrez Visual Studio.

  2. Dans le menu Fichier , pointez sur Nouveau, puis cliquez sur Projet.

  3. Dans le volet Modèles, développez Visual C# ou Visual Basic, puis développez Office/SharePoint.

  4. Sous le nœud développé Office/SharePoint , sélectionnez le nœud Compléments Office .

  5. Dans la liste des modèles de projet, sélectionnez Complément Excel 2010 ou Complément Excel 2013.

  6. Dans la zone Nom , tapez FirstExcelAddIn.

  7. Cliquez sur OK.

    Visual Studio crée le projet FirstExcelAddIn et ouvre le fichier de code ThisAddIn dans l’éditeur.

Écrire du code pour ajouter du texte au classeur enregistré

L'étape suivante consiste à ajouter du code au fichier de code ThisAddIn. Le nouveau code utilise le modèle objet d'Excel pour insérer du texte réutilisable dans la première ligne de la feuille de calcul active. La feuille de calcul active est celle qui est ouverte quand l'utilisateur enregistre le classeur. Par défaut, le fichier de code ThisAddIn contient le code généré suivant :

  • Une définition partielle de la classe ThisAddIn . Cette classe fournit un point d'entrée pour votre code et offre un accès au modèle objet d'Excel. Pour plus d’informations, consultez Les compléments VSTO program. Le reste de la ThisAddIn classe est défini dans un fichier de code masqué que vous ne devez pas modifier.

  • Les gestionnaires d'événements ThisAddIn_Startup et ThisAddIn_Shutdown . Ces gestionnaires d'événements sont appelés quand Excel charge et décharge votre complément VSTO. Utilisez ces gestionnaires d'événements pour initialiser votre complément VSTO quand il est chargé et pour nettoyer les ressources utilisées par votre complément quand il est déchargé. Pour plus d’informations, consultez Événements dans Bureau projets.

Pour ajouter une ligne de texte au classeur enregistré

  1. Dans le fichier de code ThisAddIn, ajoutez le code suivant à la classe ThisAddIn . Le nouveau code définit un gestionnaire d'événements pour l'événement WorkbookBeforeSave qui est déclenché quand un classeur est enregistré.

    Quand l'utilisateur enregistre un classeur, le gestionnaire d'événements ajoute le nouveau texte au début de la feuille de calcul active.

    void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI, ref bool Cancel)
{
    Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet);
    Excel.Range firstRow = activeWorksheet.get_Range("A1");
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown);
    Excel.Range newFirstRow = activeWorksheet.get_Range("A1");
    newFirstRow.Value2 = "This text was added by using code";
}

  2. Si vous utilisez C#, ajoutez le code requis suivant au gestionnaire d'événements ThisAddIn_Startup . Ce code permet de connecter le gestionnaire d'événements Application_WorkbookBeforeSave à l'événement WorkbookBeforeSave .

    this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);

    Pour modifier le classeur quand il est enregistré, les exemples de code précédents utilisent les objets suivants :

  • Le champ Application de la classe ThisAddIn . Le champ Application retourne un objet Application qui représente l'instance actuelle d'Excel.

  • Le paramètre Wb du gestionnaire d'événements pour l'événement WorkbookBeforeSave . Le paramètre Wb est un objet Workbook qui représente le classeur enregistré. Pour plus d’informations, consultez vue d’ensemble du modèle objet Excel.

Tester le projet

Pour tester le projet

  1. Appuyez sur F5 pour générer et exécuter votre projet.

    Quand vous générez le projet, le code est compilé dans un assembly qui est inclus dans le dossier de sortie de la génération du projet. Visual Studio crée également un jeu d'entrées de Registre qui permet à Excel de détecter et de charger le complément VSTO, et il configure les paramètres de sécurité de l'ordinateur de développement pour permettre au complément VSTO de s'exécuter. Pour plus d’informations, consultez Générer des solutions Bureau.

  2. Dans Excel, enregistrez le classeur.

  3. Vérifiez que le texte suivant est ajouté au classeur.

    Ce texte a été ajouté via le code.

  4. Fermez Excel.

Nettoyer le projet

Une fois que vous avez terminé de développer un projet, supprimez l'assembly du complément VSTO, les entrées de Registre et les paramètres de sécurité de votre ordinateur de développement. Sinon, le complément VSTO s'exécute chaque fois que vous ouvrez Excel sur votre ordinateur de développement.

Pour nettoyer le projet terminé sur votre ordinateur de développement

  1. Dans Visual Studio, dans le menu Générer , cliquez sur Nettoyer la solution.

Étapes suivantes

Maintenant que vous avez créé un complément VSTO de base pour Excel, vous pouvez perfectionner votre connaissance du développement des compléments VSTO en consultant les rubriques suivantes :

  • Tâches de programmation générales que vous pouvez effectuer dans les compléments VSTO : Programmes de compléments VSTO.

  • Tâches de programmation spécifiques aux compléments VSTO Excel : solutions Excel.

  • Utilisation du modèle objet d’Excel : Vue d’ensemble du modèle objet Excel.

  • Personnalisation de l’interface utilisateur d’Excel, par exemple en ajoutant un onglet personnalisé au ruban ou en créant votre propre volet Office personnalisé : Bureau Personnalisation de l’interface utilisateur.

  • Création et débogage de compléments VSTO pour Excel : Créer des solutions Bureau.

  • Déploiement de compléments VSTO pour Excel : Déployer une solution Bureau.

Contenu connexe