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

Diese exemplarischen Vorgehensweise bietet eine Einführung in das Erstellen eines VSTO-Add-Ins für Microsoft Office Word.This introductory walkthrough shows you how to create a VSTO Add-in for 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.The features that you create in this kind of solution are available to the application itself, regardless of which documents are open.

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

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

  • Erstellen eines VSTO-Add-In-Projekts.Creating a Word VSTO Add-in project.

  • Schreiben von Code, in dem das Word-Objektmodell zum Hinzufügen von Text zu einem Dokument beim Speichern verwendet wird.Writing code that uses the object model of Word to add text to a document when it is saved.

  • 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.

VorraussetzungenPrerequisites

Zum Durchführen dieser exemplarischen Vorgehensweise benötigen Sie die folgenden Komponenten:You need the following components to complete this walkthrough:

Erstellen eines ProjektsCreate the project

So erstellen Sie ein neues Word VSTO-Add-In-Projekt in Visual StudioTo create a new Word VSTO Add-in 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 Basicund 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 Word VSTO-Add-In-Projekt aus.In the list of project templates, select a Word VSTO Add-in project.

  6. In der Namen geben FirstWordAddIn.In the Name box, type FirstWordAddIn.

  7. Klicken Sie auf OK.Click OK.

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

Schreiben Sie Code zum Hinzufügen von Text zum gespeicherten DokumentWrite code to add text to the saved document

Als Nächstes fügen Sie der Codedatei "ThisAddIn" Code hinzu.Next, add code to the ThisAddIn code file. Der neue Code verwendet das Word-Objektmodell, um jedem gespeicherten einen Textbaustein hinzuzufügen.The new code uses the object model of Word to add boilerplate text to each saved document. 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 Objektmodell von Word.This class provides an entry point for your code and provides access to the object model of Word. Weitere Informationen finden Sie unter Programm VSTO-Add-ins. Der Rest der ThisAddIn -Klasse ist in einer ausgeblendeten Codedatei definiert, die nicht geändert werden darf.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 Word geladen und entladen wird.These event handlers are called when Word 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 dem gespeicherten Dokument einen Textabsatz hinzuTo add a paragraph of text to the saved document

  1. 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. Mit dem neuen Code wird ein Ereignishandler für das Ereignis DocumentBeforeSave definiert, das ausgelöst wird, wenn ein Dokument gespeichert wird.The new code defines an event handler for the DocumentBeforeSave event, which is raised when a document is saved.

    Wenn der Benutzer ein Dokument speichert, fügt der Ereignishandler am Anfang des Dokuments neuen Text hinzu.When the user saves a document, the event handler adds new text at the start of the document.

    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

    Dieser Code verwendet den Indexwert 1, um auf den ersten Absatz in der Auflistung Paragraphs zuzugreifen.This code uses an index value of 1 to access the first paragraph in the Paragraphs collection. Obwohl Visual Basic und Visual C# auf Null basierende Arrays verwenden, ist die untere Arraygrenze der meisten Auflistungen im Word-Objektmodell 1.Although Visual Basic and Visual C# use 0-based arrays, the lower array bounds of most collections in the Word object model is 1. Weitere Informationen finden Sie unter schreiben Sie Code in Office-Projektmappen.For more information, see Write code in Office solutions.

  2. Wenn Sie C# verwenden, fügen Sie dem ThisAddIn_Startup -Ereignishandler den folgenden erforderlichen Code hinzu.If you are using C#, add the following required code to the ThisAddIn_Startup event handler. Dieser Code wird verwendet, um den Application_DocumentBeforeSave -Ereignishandler mit dem DocumentBeforeSave -Ereignis zu verbinden.This code is used to connect the Application_DocumentBeforeSave event handler with the DocumentBeforeSave event.

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

    Zum Ändern des Dokuments beim Speichern wurden in den vorherigen Codebeispielen die folgenden Objekte verwendet:To modify the document when it is saved, the previous code examples use the following objects:

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

  • Der Doc -Parameter des Ereignishandlers für das DocumentBeforeSave -Ereignis.The Doc parameter of the event handler for the DocumentBeforeSave event. Der Parameter Doc ist ein Document-Objekt, das das gespeicherte Dokument darstellt.The Doc parameter is a Document object, which represents the saved document. Weitere Informationen finden Sie unter Übersicht über das Word-Objektmodell.For more information, see Word object model overview.

Testen Sie das ProjektTest the project

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 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.Visual Studio also creates a set of registry entries that enable Word 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 erstellen Office-Projektmappen.For more information, see Build Office solutions.

  2. Speichern Sie das aktive Dokument in Word.In Word, save the active document.

  3. Stellen Sie sicher, dass dem Dokument der folgende Text hinzugefügt wurde.Verify that the following text is added to the document.

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

  4. Schließen Sie Word.Close Word.

Bereinigen Sie das ProjektClean 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 weiterhin jedes Mal ausgeführt, wenn Sie Word auf dem Entwicklungscomputer öffnen.Otherwise, the VSTO Add-in will continue to run every time that you open Word on your development computer.

So bereinigen Sie das abgeschlossene Projekt auf dem EntwicklungscomputerTo clean up the completed project on your development computer

  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 Word erstellt haben, können Sie in den folgenden Themen mehr über die Entwicklung von VSTO-Add-Ins erfahren:Now that you have created a basic VSTO Add-in for Word, you can learn more about how to develop VSTO Add-ins from these topics:

Siehe auchSee also