Exemplarische Vorgehensweise: Erstellen des ersten Add-Ins auf Anwendungsebene für Word

Aktualisiert: Juli 2008

Betrifft

Die Informationen in diesem Thema gelten nur für die angegebenen Projekte und Versionen von Visual Studio Tools for Office von Microsoft Office.

Projekttyp

  • Projekte auf Anwendungsebene

Microsoft Office-Version

  • Word 2007

  • Word 2003

Weitere Informationen hierzu finden Sie unter Verfügbare Features nach Anwendung und Projekttyp.

In dieser einführenden exemplarischen Vorgehensweise wird erläutert, wie Sie ein Add-In auf Anwendungsebene für Microsoft Office Word erstellen. Die Features, die Sie in dieser Art von Projektmappe erstellen, sind für die Anwendung selbst verfügbar, unabhängig davon, welche Dokumente geöffnet sind.

In dieser exemplarischen Vorgehensweise werden die folgenden Aufgaben veranschaulicht:

  • Erstellen eines Add-In-Projekts für Word 2003 oder Word 2007

  • Schreiben von Code, der das Word-Objektmodell zum Hinzufügen von Text zu einem Dokument beim Speichern verwendet

  • Erstellen und Ausführen des Projekts zum Testen

  • Bereinigen des abgeschlossenen Projekts, damit das Add-In nicht mehr automatisch auf dem Entwicklungscomputer ausgeführt wird

Hinweis:

Ihr Computer zeigt möglicherweise für einige der Elemente der Visual Studio-Benutzeroberfläche in der folgenden Anleitung andere Namen oder Standorte an. Diese Elemente sind von der jeweiligen Visual Studio-Version und den verwendeten Einstellungen abhängig. Weitere Informationen finden Sie unter Visual Studio-Einstellungen.

Vorbereitungsmaßnahmen

Zum Durchführen dieser exemplarischen Vorgehensweise benötigen Sie die folgenden Komponenten:

  • Visual Studio Tools for Office (eine optionale Komponente von Visual Studio 2008 Professional und Visual Studio Team System).

  • Word 2003 oder Word 2007.

Visual Studio Tools for Office wird standardmäßig mit den aufgeführten Versionen von Visual Studio installiert. Wie Sie überprüfen können, ob die Software installiert ist, erfahren Sie in Installieren von Visual Studio Tools for Office.

Erstellen des Projekts

So erstellen Sie ein neues Add-In-Projekt für Word in Visual Studio

  1. Starten Sie Visual Studio.

  2. Zeigen Sie im Menü Datei auf Neu, und klicken Sie dann auf Projekt.

  3. Erweitern Sie im Bereich Projekttypen den Knoten Visual C# oder Visual Basic, und erweitern Sie dann Office.

  4. Wählen Sie den Ordner 2007, wenn Sie ein Add-In für Word 2007 entwickeln, oder wählen Sie den Ordner 2003, wenn Sie ein Add-In für Word 2003 entwickeln.

  5. Wählen Sie im Bereich Vorlagen die Optionen Word 2003-Add-In oder Word 2007-Add-In aus.

  6. Geben Sie im Feld Name die Zeichenfolge FirstWordAddIn ein.

  7. Klicken Sie auf OK.

    Visual Studio erstellt das Projekt FirstWordAddIn und öffnet die ThisAddIn-Codedatei im Editor.

Schreiben von Code zum Hinzufügen von Text zum gespeicherten Dokument

Fügen Sie anschließend der ThisAddIn-Codedatei Code hinzu. Der neue Code verwendet das Word-Objektmodell, um jedem gespeicherten Dokument Text mit Codebausteinen hinzuzufügen. Standardmäßig enthält die ThisAddIn-Codedatei den folgenden generierten Code:

  • Eine partielle Definition der ThisAddIn-Klasse. Diese Klasse liefert einen Einstiegspunkt für den Code und ermöglicht den Zugriff auf das Word-Objektmodell. Weitere Informationen hierzu finden Sie unter AddIn-Hostelement. Der Rest der ThisAddIn-Klasse ist in einer ausgeblendeten Codedatei definiert, die Sie nicht ändern sollten.

  • Der ThisAddIn_Startup-Ereignishandler und der ThisAddIn_Shutdown-Ereignishandler. Diese Ereignishandler werden aufgerufen, wenn das Add-In von Word geladen und entladen wird. Verwenden Sie diese Ereignishandler, um das Add-In zu initialisieren, wenn es geladen wird, und um beim Entladen die Ressourcen zu bereinigen, die vom Add-In verwendet werden. Weitere Informationen finden Sie unter Visual Studio Tools for Office-Projektereignisse.

So fügen Sie dem gespeicherten Dokument einen Textabsatz hinzu

  1. Fügen Sie in der ThisAddIn-Codedatei der ThisAddIn-Klasse folgenden Code hinzu. Der neue Code definiert einen Ereignishandler für das DocumentBeforeSave-Ereignis, das beim Speichern eines Dokuments ausgelöst wird.

    Wenn der Benutzer ein Dokument speichert, fügt der Ereignishandler neuen Text am Anfang des Dokuments hinzu.

    Private Sub Application_DocumentBeforeSave(ByVal Doc As Word.Document, ByRef SaveAsUI As Boolean, _
        ByRef Cancel As Boolean) Handles Application.DocumentBeforeSave
        Doc.Paragraphs(1).Range.InsertParagraphBefore()
        Doc.Paragraphs(1).Range.Text = "This text was added by using code."
    End Sub
    
    void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
    {
        Doc.Paragraphs[1].Range.InsertParagraphBefore();
        Doc.Paragraphs[1].Range.Text = "This text was added by using code.";
    }
    
    Hinweis:

    In diesem Code wird der Indexwert 1 verwendet, um auf den ersten Absatz in der Paragraphs-Auflistung zuzugreifen. Auch wenn Visual Basic und Visual C# nullbasierte Arrays verwenden, sind die unteren Arraybegrenzungen in den meisten Auflistungen des Word-Objektmodells 1. Weitere Informationen finden Sie unter Programmieren mit Visual Basic im Vergleich zu C#.

  2. Wenn Sie C# verwenden, fügen Sie den folgenden Code dem ThisAddIn_Startup-Ereignishandler hinzu: Dieser Code wird verwendet, um den Application_DocumentBeforeSave-Ereignishandler mit dem DocumentBeforeSave-Ereignis zu verbinden.

    this.Application.DocumentBeforeSave += 
        new Word.ApplicationEvents4_DocumentBeforeSaveEventHandler(Application_DocumentBeforeSave);
    

Um das Dokument beim Speichern zu ändern, werden in den vorherigen Codebeispielen die folgenden Objekte verwendet:

Testen des Projekts

So testen Sie das Projekt

  1. Drücken Sie F5, um das Projekt zu erstellen und auszuführen.

    Beim Erstellen des Projekts wird der Code in eine Assembly kompiliert, die in den Buildausgabeordner für das Projekt aufgenommen wird. Visual Studio erstellt auch einen Satz von Registrierungseinträgen, die es Word ermöglichen, das Add-In aufzufinden und zu laden, und konfiguriert die Sicherheitseinstellungen auf dem Entwicklungscomputer, damit das Add-In ausgeführt werden kann. Weitere Informationen hierzu finden Sie unter Übersicht über das Erstellen von Office-Projektmappen.

  2. Speichern Sie das aktive Dokument in Word.

  3. Überprüfen Sie, ob der folgende Text dem Dokument hinzugefügt wurde.

    This text was added by using code.

  4. Schließen Sie Word.

Bereinigen des Projekts

Wenn Sie die Entwicklung eines Projekts abgeschlossen haben, entfernen Sie die Add-In-Assembly, die Registrierungseinträge und die Sicherheitseinstellungen vom Entwicklungscomputer. Andernfalls wird das Add-In jedes Mal ausgeführt, wenn Sie Word auf dem Entwicklungscomputer öffnen.

So bereinigen Sie das abgeschlossene Projekt auf dem Entwicklungscomputer

  • Klicken Sie in Visual Studio im Menü Erstellen auf Projektmappe bereinigen.

Nächste Schritte

Nachdem Sie nun ein grundlegendes Add-In auf Anwendungsebene für Word erstellt haben, können Sie mehr über die Entwicklung von Add-Ins in den folgenden Themen erfahren:

Siehe auch

Konzepte

Übersicht über die Entwicklung von Office-Projektmappen

Entwicklung von Add-Ins auf Anwendungsebene für Word

Programmieren von Add-Ins auf Anwendungsebene

Übersicht über das Word-Objektmodell

Anpassung der Office-Benutzeroberfläche

Übersicht über Visual Studio Tools for Office-Projektvorlagen

Referenz

Add-In-Projektvorlagen für 2003 Microsoft Office

Add-In-Projektvorlagen für 2007 Microsoft Office

Weitere Ressourcen

Erstellen und Debuggen von Office-Projektmappen

Bereitstellen von Office-Projektmappen

Änderungsprotokoll

Datum

Versionsgeschichte

Grund

Juli 2008

Thema hinzugefügt.

Informationsergänzung.