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

Article
10/10/2023

Cette procédure pas à pas montre comment créer un complément VSTO pour 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. Pour plus d’informations, consultez Bureau vue d’ensemble du développement de solutions (VSTO).

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets de complément VSTO pour Outlook. 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 Outlook pour 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.
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 :

Une édition de Visual Studio qui inclut les outils de développement Microsoft Office. Pour plus d’informations, consultez Configurer un ordinateur pour développer des solutions Bureau.
Microsoft Outlook

Créer le projet

Pour créer un projet Outlook dans Visual Studio

Démarrez Visual Studio.
Dans le menu Fichier , pointez sur Nouveau, puis cliquez sur Projet.
Dans le volet Modèles, développez Visual C# ou Visual Basic, puis développez Office/SharePoint.
Sous le nœud développé Office/SharePoint , sélectionnez le nœud Compléments Office .
Dans la liste des modèles de projet, sélectionnez un projet de complément VSTO Outlook.
Dans la zone Nom , tapez FirstOutlookAddIn.
Cliquez sur OK.

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

Écrire du code qui ajoute du texte à chaque nouveau message électronique

L'étape suivante consiste à ajouter du code au fichier de code ThisAddIn. Le nouveau code utilise le modèle objet d'Outlook pour ajouter du texte à chaque nouveau message électronique. 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'Outlook. 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 Outlook charge et décharge votre complément VSTO. 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é. Pour plus d’informations, consultez Événements dans Bureau projets.

Pour ajouter du texte à l'objet et au corps de chaque nouveau message électronique

Dans le fichier de code ThisAddIn, déclarez un champ nommé inspectors dans la classe ThisAddIn . Le champ inspectors conserve une référence à la collection de fenêtres Inspecteur de l'instance Outlook actuelle. 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 .
- C#
- VB
```
Outlook.Inspectors inspectors;
```
```
Private WithEvents inspectors As Outlook.Inspectors
```

Remplacez la méthode ThisAddIn_Startup par le code suivant. Ce code attache un gestionnaire d'événements à l'événement NewInspector .

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    inspectors = this.Application.Inspectors;
    inspectors.NewInspector +=
    new Microsoft.Office.Interop.Outlook.InspectorsEvents_NewInspectorEventHandler(Inspectors_NewInspector);
}

Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
    inspectors = Me.Application.Inspectors
End Sub

Dans le fichier de code ThisAddIn, ajoutez le code suivant à la classe ThisAddIn . Ce code définit un gestionnaire d'événements pour l'événement NewInspector .

Lorsque l'utilisateur crée un message électronique, ce gestionnaire d'événements ajoute du texte à l'objet et au corps du message.

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";
        }

    }
}

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

Pour modifier chaque nouveau message électronique, 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'Outlook.
Le paramètre Inspector du gestionnaire d'événements pour l'événement NewInspector . Le paramètre Inspector est un objet Inspector , qui représente la fenêtre Inspecteur du nouveau message électronique. Pour plus d’informations, consultez les solutions Outlook.

Tester le projet

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.

Pour tester le projet

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 à 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. Pour plus d’informations, consultez Bureau vue d’ensemble du processus de génération de solution.
Dans Outlook, créez un nouveau message électronique.
Vérifiez que le texte suivant est ajouté à la ligne d'objet et au corps du message.

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

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écutera chaque fois que vous ouvrirez Outlook sur l’ordinateur de développement.

Pour nettoyer votre projet

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 Outlook, 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 à l’aide des compléments VSTO pour Outlook. Pour plus d’informations, consultez Les compléments VSTO program.
Utilisation du modèle objet d'Outlook Pour plus d’informations, consultez les solutions Outlook.
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é. Pour plus d’informations, consultez Bureau Personnalisation de l’interface utilisateur.
Génération et débogage des compléments VSTO pour Outlook. Pour plus d’informations, consultez Générer des solutions Bureau.
Déploiement des compléments VSTO pour Outlook. Pour plus d’informations, consultez Déployer une solution Bureau.