Procédure pas à pas : Créer votre premier complément VSTO pour OutlookWalkthrough: Create your first VSTO Add-in for Outlook

Cette procédure pas à pas montre comment créer un complément VSTO pour Microsoft Office Outlook.This walkthrough shows you how to create a VSTO Add-in for Microsoft Office Outlook. Les fonctionnalités que vous créez dans ce type de solution sont accessibles à l'application elle-même, quel que soit l'élément Outlook ouvert.The features that you create in this kind of solution are available to the application itself, regardless of which Outlook item is open. Pour plus d’informations, consultez présentation du développement de solutions Office (VSTO).For more information, see Office solutions development overview (VSTO).

S’applique à : les informations contenues dans cette rubrique s’applique à VSTO ajouter-dans les projets pour Outlook.Applies to: The information in this topic applies to VSTO Add-in projects for Outlook. Pour plus d’informations, consultez fonctionnalités disponibles par type d’application et de projet Office.For more information, see Features available by Office application and project type.

Cette procédure pas à pas décrit les tâches suivantes :This walkthrough illustrates the following tasks:

  • Création d’un projet de complément VSTO Outlook pour Outlook.Creating an Outlook VSTO Add-in project for Outlook.

  • Écriture du code qui utilise le modèle objet d'Outlook pour ajouter du texte à l'objet et au corps d'un nouveau message électronique.Writing code that uses the object model of Outlook to add text to the subject and body of a new mail message.

  • Génération et exécution du projet pour le testerBuilding and running the project to test it.

  • Nettoyage du projet terminé, pour que le complément VSTO ne s’exécute plus automatiquement sur votre ordinateur de développementCleaning up the completed project so that the VSTO Add-in no longer runs automatically on your development computer.

    Note

    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.Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. L’édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments.The Visual Studio edition that you have and the settings that you use determine these elements. Pour plus d’informations, consultez Personnaliser l’IDE.For more information, see Personalize the IDE.

PrérequisPrerequisites

Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :You need the following components to complete this walkthrough:

Créer le projetCreate the project

Pour créer un projet Outlook dans Visual StudioTo create a new Outlook project in Visual Studio

  1. Démarrez Visual StudioVisual Studio.Start Visual StudioVisual Studio.

  2. Dans le menu Fichier , pointez sur Nouveau, puis cliquez sur Projet.On the File menu, point to New, and then click Project.

  3. Dans le volet Modèles, développez Visual C# ou Visual Basic, puis développez Office/SharePoint.In the templates pane, expand Visual C# or Visual Basic, and then expand Office/SharePoint.

  4. Sous le nœud développé Office/SharePoint , sélectionnez le nœud Compléments Office .Under the expanded Office/SharePoint node, select the Office Add-ins node.

  5. Dans la liste des modèles de projet, sélectionnez un projet de complément VSTO Outlook.In the list of project templates, choose an Outlook VSTO Add-in project.

  6. Dans la zone Nom , tapez FirstOutlookAddIn.In the Name box, type FirstOutlookAddIn.

  7. Cliquez sur OK.Click OK.

    Visual StudioVisual Studio crée le projet FirstOutlookAddIn et ouvre le fichier de code ThisAddIn dans l'éditeur. creates the FirstOutlookAddIn project and opens the ThisAddIn code file in the editor.

Écrire du code qui ajoute du texte à chaque nouveau message électroniqueWrite code that adds text to each new mail message

L'étape suivante consiste à ajouter du code au fichier de code ThisAddIn.Next, add code to the ThisAddIn code file. Le nouveau code utilise le modèle objet d'Outlook pour ajouter du texte à chaque nouveau message électronique.The new code uses the object model of Outlook to add text to each new mail message. Par défaut, le fichier de code ThisAddIn contient le code généré suivant :By default, the ThisAddIn code file contains the following generated code:

  • Une définition partielle de la classe ThisAddIn .A partial definition of the ThisAddIn class. Cette classe fournit un point d'entrée pour votre code et offre un accès au modèle objet d'Outlook.This class provides an entry point for your code and provides access to the object model of Outlook. Pour plus d’informations, consultez programme VSTO Add-ins. Le reste de la classe ThisAddIn est défini dans un fichier de code masqué que vous ne devez pas modifier.For more information, see Program VSTO Add-ins. The remainder of the ThisAddIn class is defined in a hidden code file that you should not modify.

  • Les gestionnaires d'événements ThisAddIn_Startup et ThisAddIn_Shutdown .The ThisAddIn_Startup and ThisAddIn_Shutdown event handlers. Ces gestionnaires d’événements sont appelés quand Outlook charge et décharge votre complément VSTO.These event handlers are called when Outlook loads and unloads your VSTO Add-in. Utilisez ces gestionnaires d'événements pour initialiser votre complément VSTO quand il est chargé, ainsi que pour nettoyer les ressources utilisées par votre complément VSTO quand il est déchargé.Use these event handlers to initialize your VSTO Add-in when it is loaded, and to clean up resources used by your VSTO Add-in when it is unloaded. Pour plus d’informations, consultez événements dans les projets Office.For more information, see Events in Office projects.

Pour ajouter du texte à l'objet et au corps de chaque nouveau message électroniqueTo add text to the subject and body of each new mail message

  1. Dans le fichier de code ThisAddIn, déclarez un champ nommé inspectors dans la classe ThisAddIn .In the ThisAddIn code file, declare a field named inspectors in the ThisAddIn class. Le champ inspectors conserve une référence à la collection de fenêtres Inspecteur de l'instance Outlook actuelle.The inspectors field maintains a reference to the collection of Inspector windows in the current Outlook instance. Cette référence empêche le garbage collector de libérer la mémoire qui contient le gestionnaire d'événements pour l'événement NewInspector .This reference prevents the garbage collector from freeing the memory that contains the event handler for the NewInspector event.

    Private WithEvents inspectors As Outlook.Inspectors
    
    Outlook.Inspectors inspectors;
    
  2. Remplacez la méthode ThisAddIn_Startup par le code suivant.Replace the ThisAddIn_Startup method with the following code. Ce code attache un gestionnaire d'événements à l'événement NewInspector .This code attaches an event handler to the NewInspector event.

    Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
        inspectors = Me.Application.Inspectors
    End Sub
    
    private void ThisAddIn_Startup(object sender, System.EventArgs e)
    {
        inspectors = this.Application.Inspectors;
        inspectors.NewInspector +=
        new Microsoft.Office.Interop.Outlook.InspectorsEvents_NewInspectorEventHandler(Inspectors_NewInspector);
    }
    
  3. Dans le fichier de code ThisAddIn, ajoutez le code suivant à la classe ThisAddIn .In the ThisAddIn code file, add the following code to the ThisAddIn class. Ce code définit un gestionnaire d'événements pour l'événement NewInspector .This code defines an event handler for the NewInspector event.

    Lorsque l'utilisateur crée un message électronique, ce gestionnaire d'événements ajoute du texte à l'objet et au corps du message.When the user creates a new mail message, this event handler adds text to the subject line and body of the message.

    Private Sub inspectors_NewInspector(ByVal Inspector As Microsoft.Office.Interop.Outlook.Inspector) Handles inspectors.NewInspector
        Dim mailItem As Outlook.MailItem = TryCast(Inspector.CurrentItem, Outlook.MailItem)
        If Not (mailItem Is Nothing) Then
            If mailItem.EntryID Is Nothing Then
                mailItem.Subject = "This text was added by using code"
                mailItem.Body = "This text was added by using code"
            End If
        End If
    End Sub
    
    void Inspectors_NewInspector(Microsoft.Office.Interop.Outlook.Inspector Inspector)
    {
        Outlook.MailItem mailItem = Inspector.CurrentItem as Outlook.MailItem;
        if (mailItem != null)
        {
            if (mailItem.EntryID == null)
            {
                mailItem.Subject = "This text was added by using code";
                mailItem.Body = "This text was added by using code";
            }
    
        }
    }
    

    Pour modifier chaque nouveau message électronique, les exemples de code précédents utilisent les objets suivants :To modify each new mail message, the previous code examples use the following objects:

Le projet de testTest the project

Lorsque vous générez et exécutez le projet, vérifiez que le texte s'affiche dans la ligne d'objet et le corps d'un nouveau message électronique.When you build and run the project, verify that the text appears in the subject line and body of a new mail message.

Pour tester le projetTo test the project

  1. Appuyez sur F5 pour générer et exécuter votre projet.Press F5 to build and run your project.

    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.When you build the project, the code is compiled into an assembly that is included in the build output folder for the project. Visual Studio crée également un jeu d’entrées de Registre qui permet à Outlook 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.Visual Studio also creates a set of registry entries that enable Outlook to discover and load the VSTO Add-in, and it configures the security settings on the development computer to enable the VSTO Add-in to run. Pour plus d’informations, consultez vue d’ensemble des processus de génération de solution Office.For more information, see Office solution build process overview.

  2. Dans Outlook, créez un nouveau message électronique.In Outlook, create a new mail message.

  3. Vérifiez que le texte suivant est ajouté à la ligne d'objet et au corps du message.Verify that the following text is added to both the subject line and body of the message.

    Ce texte a été ajouté via le code.This text was added by using code.

  4. Fermez Outlook.Close Outlook.

Nettoyer le projetClean up the project

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.When you finish developing a project, remove the VSTO Add-in assembly, registry entries, and security settings from your development computer. Sinon, le complément VSTO s’exécutera chaque fois que vous ouvrirez Outlook sur l’ordinateur de développement.Otherwise, the VSTO Add-in will run every time that you open Outlook on the development computer.

Pour nettoyer votre projetTo clean up your project

  1. Dans Visual Studio, dans le menu Générer , cliquez sur Nettoyer la solution.In Visual Studio, on the Build menu, click Clean Solution.

Étapes suivantesNext steps

Maintenant que vous avez créé un complément VSTO de base pour Outlook, vous pouvez perfectionner votre connaissance du développement des compléments VSTO en consultant les rubriques suivantes :Now that you have created a basic VSTO Add-in for Outlook, you can learn more about how to develop VSTO Add-ins from these topics:

  • Tâches de programmation générales que vous pouvez effectuer à l’aide des compléments VSTO pour Outlook.General programming tasks that you can perform by using VSTO Add-ins for Outlook. Pour plus d’informations, consultez programme VSTO Add-ins.For more information, see Program VSTO Add-ins.

  • Utilisation du modèle objet d'OutlookUsing the object model of Outlook. Pour plus d’informations, consultez solutions Outlook.For more information, see Outlook solutions.

  • Personnalisation de l'interface utilisateur d'Outlook en ajoutant un onglet personnalisé au ruban ou en créant votre propre volet des tâches personnalisé.Customizing the UI of Outlook, for example, by adding a custom tab to the Ribbon or creating your own custom task pane. Pour plus d’informations, consultez personnalisation de l’interface utilisateur Office.For more information, see Office UI customization.

  • Génération et débogage des compléments VSTO pour Outlook.Building and debugging VSTO Add-ins for Outlook. Pour plus d’informations, consultez solutions Office Build.For more information, see Build Office solutions.

  • Déploiement des compléments VSTO pour Outlook.Deploying VSTO Add-ins for Outlook. Pour plus d’informations, consultez déployer une solution Office.For more information, see Deploy an Office solution.

Voir aussiSee also

Programmer des Compléments VSTO Program VSTO Add-ins
Solutions Outlook Outlook solutions
Personnalisation de l’interface utilisateur Office Office UI customization
Générer des solutions Office Build Office solutions
Déployer une solution Office Deploy an Office solution
Vue d’ensemble des modèles de projet OfficeOffice project templates overview