Exemplarische Vorgehensweise: Erstellen des ersten VSTO-Add-Ins für OutlookWalkthrough: Create your first VSTO Add-in for Outlook

Diese exemplarische Vorgehensweise veranschaulicht die Erstellung eines VSTO-Add-Ins für Microsoft Office Outlook.This walkthrough shows you how to create a VSTO Add-in for Microsoft Office Outlook. Die in dieser Art von Projektmappe erstellten Features sind für die Anwendung selbst verfügbar. Dabei spielt es keine Rolle, welches Outlook-Element geöffnet sind.The features that you create in this kind of solution are available to the application itself, regardless of which Outlook item is open. Weitere Informationen finden Sie unter Übersicht über die Entwicklung von Office-Lösungen (VSTO-).For more information, see Office solutions development overview (VSTO).

Gilt für: Die Informationen in diesem Thema betreffen VSTO-Add - in-Projekte für Outlook.Applies to: The information in this topic applies to VSTO Add-in projects for Outlook. Weitere Informationen finden Sie unter verfügbare Funktionen nach Office-Anwendung und Projekttyp.For more information, see Features available by Office application and project type.

Hinweis

Möchten Sie Lösungen entwickeln, die die Office-Funktionen auf mehrere Plattformen ausweiten?Interested in developing solutions that extend the Office experience across multiple platforms? Sehen Sie sich das neue Office-Add-ins-Modellan.Check out the new Office Add-ins model. Office-Add-ins haben im Vergleich zu VSTO-Add-Ins und-Lösungen einen geringen Speicherbedarf, und Sie können Sie mithilfe von fast allen webprogrammierungs Technologien wie HTML5, JavaScript, CSS3 und XML erstellen.Office Add-ins have a small footprint compared to VSTO Add-ins and solutions, and you can build them by using almost any web programming technology, such as HTML5, JavaScript, CSS3, and XML.

In dieser exemplarischen Vorgehensweise werden die folgenden Aufgaben veranschaulicht:This walkthrough illustrates the following tasks:

  • Erstellen eines VSTO-Add-In-Projekts für OutlookCreating an Outlook VSTO Add-in project for Outlook.

  • Schreiben von Code, der das Outlook-Objektmodell verwendet, um der Betreffzeile und dem Textkörper einer neuen E-Mail Text hinzuzufügenWriting code that uses the object model of Outlook to add text to the subject and body of a new mail message.

  • Erstellen Sie das Projekt, und führen Sie es aus, um es zu testen.Building and running the project to test it.

  • Bereinigen des abgeschlossenen Projekts, damit das VSTO-Add-In nicht mehr automatisch auf Ihrem Entwicklungscomputer ausgeführt wird.Cleaning up the completed project so that the VSTO Add-in no longer runs automatically on your development computer.

    Hinweis

    Auf Ihrem Computer werden möglicherweise andere Namen oder Speicherorte für die Benutzeroberflächenelemente von Visual Studio angezeigt als die in den folgenden Anweisungen aufgeführten.Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. Diese Elemente sind von der jeweiligen Visual Studio-Version und den verwendeten Einstellungen abhängig.The Visual Studio edition that you have and the settings that you use determine these elements. Weitere Informationen finden Sie unter Personalisieren der IDE.For more information, see Personalize the IDE.

VoraussetzungenPrerequisites

Zum Abschließen dieser exemplarischen Vorgehensweise benötigen Sie Folgendes:You need the following components to complete this walkthrough:

Erstellen des ProjektsCreate the project

So erstellen Sie ein neues Outlook-Projekt in Visual StudioTo create a new Outlook project in Visual Studio

  1. Starten Sie Visual StudioVisual Studio.Start Visual StudioVisual Studio.

  2. Zeigen Sie im Menü Datei auf Neu, und klicken Sie dann auf Projekt.On the File menu, point to New, and then click Project.

  3. Erweitern Sie im Vorlagenbereich Visual C# oder Visual Basic und dann Office/SharePoint.In the templates pane, expand Visual C# or Visual Basic, and then expand Office/SharePoint.

  4. Wählen Sie unter dem erweiterten Knoten Office/SharePoint den Knoten Office-Add-Ins aus.Under the expanded Office/SharePoint node, select the Office Add-ins node.

  5. Wählen Sie in der Liste der Projektvorlagen ein Outlook-VSTO-Add-In-Projekt aus.In the list of project templates, choose an Outlook VSTO Add-in project.

  6. Geben Sie im Feld Name den Text FirstOutlookAddIn ein.In the Name box, type FirstOutlookAddIn.

  7. Klicken Sie auf OK.Click OK.

    Visual StudioVisual Studio erstellt das FirstOutlookAddIn -Projekt und öffnet die Codedatei " ThisAddIn " im Editor.creates the FirstOutlookAddIn project and opens the ThisAddIn code file in the editor.

Schreiben von Code, der jeder neuen e-Mail-Nachricht Text hinzufügtWrite code that adds text to each new mail message

Als Nächstes fügen Sie der Codedatei "ThisAddIn" Code hinzu.Next, add code to the ThisAddIn code file. Der neue Code verwendet das Outlook-Objektmodell, um jeder neuen E-Mail Text hinzuzufügen.The new code uses the object model of Outlook to add text to each new mail message. Standardmäßig enthält die Codedatei "ThisAddIn" den folgenden generierten Code:By default, the ThisAddIn code file contains the following generated code:

  • Eine Teildefinition der ThisAddIn -Klasse.A partial definition of the ThisAddIn class. Diese Klasse stellt einen Einstiegspunkt für Ihren Code bereit und ermöglicht den Zugriff auf das Outlook-Objektmodell.This class provides an entry point for your code and provides access to the object model of Outlook. Weitere Informationen finden Sie unter Program VSTO Add-ins. Der Rest der- ThisAddIn Klasse wird in einer ausgeblendeten Codedatei definiert, die nicht geändert werden sollte.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.

  • Die Ereignishandler ThisAddIn_Startup und ThisAddIn_Shutdown .The ThisAddIn_Startup and ThisAddIn_Shutdown event handlers. Diese Ereignishandler werden aufgerufen, wenn Ihr VSTO-Add-In von Outlook geladen oder entladen wird.These event handlers are called when Outlook loads and unloads your VSTO Add-in. Verwenden Sie diese Ereignishandler zum Initialisieren des VSTO-Add-Ins, wenn es geladen wird, und zum Bereinigen der vom VSTO-Add-In verwendeten Ressourcen, wenn es entladen wird.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. Weitere Informationen finden Sie unter Ereignisse in Office-Projekten.For more information, see Events in Office projects.

So fügen Sie der Betreffzeile und dem Textkörper jeder neuen E-Mail Text hinzuTo add text to the subject and body of each new mail message

  1. Deklarieren Sie in der ThisAddIn-Codedatei ein Feld namens inspectors in der ThisAddIn -Klasse.In the ThisAddIn code file, declare a field named inspectors in the ThisAddIn class. Das inspectors -Feld behält einen Verweis auf die Auflistung von Inspektor-Fenstern in der aktuellen Outlook-Instanz.The inspectors field maintains a reference to the collection of Inspector windows in the current Outlook instance. Dieser Verweis verhindert, dass der Garbage Collector den Speicher freigibt, der den Ereignishandler für das NewInspector -Ereignis enthält.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. Ersetzen Sie die ThisAddIn_Startup-Methode durch den folgenden Code.Replace the ThisAddIn_Startup method with the following code. Dieser Code fügt einen Ereignishandler an das NewInspector -Ereignis an.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. Fügen Sie in der Codedatei „ThisAddIn“ der ThisAddIn -Klasse den folgenden Code hinzu.In the ThisAddIn code file, add the following code to the ThisAddIn class. Dieser Code definiert einen Ereignishandler für das NewInspector -Ereignis.This code defines an event handler for the NewInspector event.

    Wenn der Benutzer eine neue E-Mail erstellt, fügt dieser Ereignishandler der Betreffzeile und dem Textkörper der Nachricht Text hinzu.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";
            }
    
        }
    }
    

    Zum Ändern der einzelnen neuen E-Mails werden in den vorherigen Codebeispielen die folgenden Objekte verwendet:To modify each new mail message, the previous code examples use the following objects:

  • Das Application -Feld der ThisAddIn -Klasse.The Application field of the ThisAddIn class. Das Application -Feld gibt ein Application -Objekt zurück, das für die aktuelle Instanz von Outlook steht.The Application field returns an Application object, which represents the current instance of Outlook.

  • Der Inspector -Parameter des Ereignishandlers für das NewInspector -Ereignis.The Inspector parameter of the event handler for the NewInspector event. Der Inspector -Parameter ist ein Inspector -Objekt, das das Inspektorfenster der neuen E-Mail darstellt.The Inspector parameter is an Inspector object, which represents the Inspector window of the new mail message. Weitere Informationen finden Sie unter Outlook-Lösungen.For more information, see Outlook solutions.

Testen des ProjektsTest the project

Wenn Sie das Projekt erstellen und ausführen, stellen Sie sicher, dass der Text in der Betreffzeile und dem Textkörper der neuen E-Mail angezeigt wird.When you build and run the project, verify that the text appears in the subject line and body of a new mail message.

So testen Sie das ProjektTo test the project

  1. Drücken Sie F5 , um das Projekt zu erstellen und auszuführen.Press F5 to build and run your project.

    Wenn Sie das Projekt erstellen, wird der Code in eine Assembly kompiliert, die im Buildausgabeordner des Projekts enthalten ist.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 erstellt auch einen Satz von Registrierungseinträgen, mit deren Hilfe Outlook das VSTO-Add-In ermitteln und laden kann. Die Sicherheitseinstellungen auf dem Entwicklungscomputer werden so konfiguriert, dass das VSTO-Add-In ausgeführt werden kann.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. Weitere Informationen finden Sie unter Übersicht über den Buildprozess für Office-Lösungen.For more information, see Office solution build process overview.

  2. Erstellen Sie in Outlook eine neue E-Mail.In Outlook, create a new mail message.

  3. Stellen Sie sicher, dass der folgende Text sowohl der Betreffzeile als auch dem Textkörper der Nachricht hinzugefügt wird.Verify that the following text is added to both the subject line and body of the message.

    Dieser Text wurde per Code hinzugefügt.This text was added by using code.

  4. Schließen Sie Outlook.Close Outlook.

Bereinigen des ProjektsClean up the project

Wenn Sie die Entwicklung eines Projekts abgeschlossen haben, entfernen Sie die VSTO-Add-In-Assembly, die Registrierungseinträge und die Sicherheitseinstellungen vom Entwicklungscomputer.When you finish developing a project, remove the VSTO Add-in assembly, registry entries, and security settings from your development computer. Andernfalls wird das VSTO-Add-In jedes Mal ausgeführt, wenn Sie Outlook auf dem Entwicklungscomputer öffnen.Otherwise, the VSTO Add-in will run every time that you open Outlook on the development computer.

So bereinigen Sie das ProjektTo clean up your project

  1. Klicken Sie in Visual Studio im Menü Build auf Projektmappe bereinigen.In Visual Studio, on the Build menu, click Clean Solution.

Nächste SchritteNext steps

Nachdem Sie nun ein einfaches VSTO-Add-In für Outlook erstellt haben, erfahren Sie in den folgenden Themen mehr über die Entwicklung von VSTO-Add-Ins: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:

  • Allgemeine Programmieraufgaben, die Sie ausführen können, indem Sie VSTO-Add-Ins für Outlook verwenden.General programming tasks that you can perform by using VSTO Add-ins for Outlook. Weitere Informationen finden Sie unter Program VSTO Add-ins.For more information, see Program VSTO Add-ins.

  • Verwenden des Outlook-Objektmodells.Using the object model of Outlook. Weitere Informationen finden Sie unter Outlook-Lösungen.For more information, see Outlook solutions.

  • Anpassen der Outlook-Benutzeroberfläche (UI) beispielsweise durch das Hinzufügen einer benutzerdefinierten Registerkarte zum Menüband oder durch das Erstellen eines eigenen benutzerdefinierten Aufgabenbereichs.Customizing the UI of Outlook, for example, by adding a custom tab to the Ribbon or creating your own custom task pane. Weitere Informationen finden Sie unter Anpassung der Office-Benutzeroberfläche.For more information, see Office UI customization.

  • Erstellen und Debuggen von VSTO-Add-Ins für Outlook.Building and debugging VSTO Add-ins for Outlook. Weitere Informationen finden Sie unter Erstellen von Office-Projektmappen.For more information, see Build Office solutions.

  • Bereitstellen von VSTO-Add-Ins für Outlook.Deploying VSTO Add-ins for Outlook. Weitere Informationen finden Sie unter Bereitstellen einer Office-Projekt Mappe.For more information, see Deploy an Office solution.

Weitere InformationenSee also