Exemplarische Vorgehensweise: Erstellen Ihres ersten VSTO-Add-Ins für Word

  • Artikel

Diese exemplarischen Vorgehensweise bietet eine Einführung in das Erstellen eines VSTO-Add-Ins für Microsoft Office Word. Die Features, die Sie in dieser Art von Projektmappe erstellen, sind für die Anwendung selbst verfügbar. Dabei spielt es keine Rolle, welche Dokumente geöffnet sind.

Gilt für: Die Informationen in diesem Thema gelten für VSTO-Add-In-Projekte für Word. Weitere Informationen finden Sie unter features available by Office-App lication and project type.

In dieser exemplarischen Vorgehensweise werden die folgenden Aufgaben veranschaulicht:

  • Erstellen eines VSTO-Add-In-Projekts.

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

  • Erstellen Sie das Projekt, und führen Sie es aus, um es zu testen.

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

    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. Diese Elemente sind von der jeweiligen Visual Studio-Version und den verwendeten Einstellungen abhängig. Weitere Informationen finden Sie unter Personalisieren der IDE.

Voraussetzungen

Zum Abschließen dieser exemplarischen Vorgehensweise benötigen Sie Folgendes:

Erstellen des Projekts

So erstellen Sie ein neues Word VSTO-Add-In-Projekt 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 Vorlagenbereich Visual C# oder Visual Basicund dann Office/SharePoint.

  4. Wählen Sie unter dem erweiterten Knoten Office/SharePoint den Knoten Office-Add-Ins aus.

  5. Wählen Sie in der Liste der Projektvorlagen ein Word VSTO-Add-In-Projekt aus.

  6. Geben Sie im Feld "Name" "FirstWordAddIn" ein.

  7. Klicken Sie auf OK.

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

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

Als Nächstes fügen Sie der Codedatei „ThisAddIn“ Code hinzu. Der neue Code verwendet das Word-Objektmodell, um jedem gespeicherten einen Textbaustein hinzuzufügen. Standardmäßig enthält die Codedatei „ThisAddIn“ den folgenden generierten Code:

  • Eine Teildefinition der ThisAddIn -Klasse. Diese Klasse stellt einen Einstiegspunkt für Ihren Code bereit und ermöglicht den Zugriff auf das Objektmodell von Word. Weitere Informationen finden Sie unter Programm-VSTO-Add-Ins. Der Erneute Standard der der ThisAddIn Klasse wird in einer ausgeblendeten Codedatei definiert, die Sie nicht ändern sollten.

  • Die Ereignishandler ThisAddIn_Startup und ThisAddIn_Shutdown . Diese Ereignishandler werden aufgerufen, wenn Ihr VSTO-Add-In von Word geladen und entladen wird. 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. Weitere Informationen finden Sie unter "Ereignisse in Office-Projekten".

So fügen Sie dem gespeicherten Dokument einen Textabsatz hinzu

  1. Fügen Sie in der Codedatei „ThisAddIn“ der ThisAddIn -Klasse den folgenden Code hinzu. Mit dem neuen Code wird ein Ereignishandler für das Ereignis DocumentBeforeSave definiert, das ausgelöst wird, wenn ein Dokument gespeichert wird.

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

    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

    Dieser Code verwendet den Indexwert 1, um auf den ersten Absatz in der Auflistung Paragraphs zuzugreifen. Obwohl Visual Basic und Visual C# auf Null basierende Arrays verwenden, ist die untere Arraygrenze der meisten Auflistungen im Word-Objektmodell 1. Weitere Informationen finden Sie unter Schreiben von Code in Office-Lösungen.

  2. Wenn Sie C# verwenden, fügen Sie dem ThisAddIn_Startup -Ereignishandler den folgenden erforderlichen Code 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);

    Zum Ändern des Dokuments beim Speichern wurden in den vorherigen Codebeispielen die folgenden Objekte verwendet:

  • Das Feld Application der ThisAddIn -Klasse. Das Feld Application gibt ein Application-Objekt zurück, das die aktuelle Instanz von Word darstellt.

  • Der Parameter Doc des Ereignishandlers für das DocumentBeforeSave -Ereignis. Der Parameter Doc ist ein Document-Objekt, das das gespeicherte Dokument darstellt. Weitere Informationen finden Sie in der Übersicht über das Word-Objektmodell.

Testen des Projekts

So testen Sie das Projekt

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

    Wenn Sie das Projekt erstellen, wird der Code in eine Assembly kompiliert, die im Buildausgabeordner des Projekts enthalten ist. Visual Studio erstellt außerdem einen Satz von Registrierungseinträgen, mit deren Hilfe Word 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. Weitere Informationen finden Sie unter Erstellen von Office-Lösungen.

  2. Speichern Sie das aktive Dokument in Word.

  3. Stellen Sie sicher, dass dem Dokument der folgende Text hinzugefügt wurde.

    Dieser Text wurde per Code hinzugefügt.

  4. Schließen Sie Word.

Bereinigen des Projekts

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

So bereinigen Sie das abgeschlossene Projekt auf dem Entwicklungscomputer

  1. Klicken Sie in Visual Studio im Menü Build auf Projektmappe bereinigen.

Nächste Schritte

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

  • Allgemeine Programmieraufgaben, die Sie in VSTO-Add-Ins ausführen können: Programm-VSTO-Add-Ins.

  • Programmieraufgaben, die für Word VSTO-Add-Ins spezifisch sind: Word-Lösungen.

  • Verwenden des Objektmodells von Word: Übersicht über das Word-Objektmodell.

  • Anpassen der Benutzeroberfläche von Word, z. B. durch Hinzufügen einer benutzerdefinierten Registerkarte zum Menüband oder Erstellen eines eigenen benutzerdefinierten Aufgabenbereichs: Anpassung der Office-Benutzeroberfläche.

  • Erstellen und Debuggen von VSTO-Add-Ins für Word: Erstellen von Office-Lösungen

  • Bereitstellen von VSTO-Add-Ins für Word: Bereitstellen einer Office-Lösung.

Zugehöriger Inhalt