Share via

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

  • Artikel

Diese exemplarische Vorgehensweise zur Einführung veranschaulicht, wie Sie ein Add-In auf Anwendungsebene für Microsoft Office Excel erstellen. Die Funktionen, die Sie in dieser Art von Projektmappe erstellen, sind für die Anwendung selbst verfügbar. Dabei spielt es keine Rolle, welche Arbeitsmappen geöffnet sind.

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

Hinweis

Möchten Sie Lösungen entwickeln, die die Office-Erfahrung auf mehreren Plattformen erweitern? Schauen Sie sich das neue Office-Add-Ins-Modell an. Office-Add-Ins haben im Vergleich zu VSTO-Add-Ins und -Lösungen einen geringen Platzbedarf, und Sie können diese mithilfe nahezu jeder Webprogrammiertechnologie erstellen, z. B. HTML5, JavaScript, CSS3 und XML.

In dieser exemplarischen Vorgehensweise werden die folgenden Aufgaben veranschaulicht:

  • Erstellen Sie ein Excel-VSTO-Add-In-Projekt für Excel.

  • Schreiben Sie Code, in dem das Excel-Objektmodell zum Hinzufügen von Text zu einer Arbeitsmappe 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 Excel-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 mit den Projektvorlagen Excel 2010-Add-In oder Excel 2013-Add-Inaus.

  6. Geben Sie im Feld Name den Text FirstExcelAddInein.

  7. Klicken Sie auf OK.

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

Schreiben von Code zum Hinzufügen von Text zur gespeicherten Arbeitsmappe

Als Nächstes fügen Sie der Codedatei „ThisAddIn“ Code hinzu. Der neue Code verwendet das Objektmodell von Excel, um einen Textbaustein in die erste Zeile des aktiven Arbeitsblatts einzufügen. Das aktive Arbeitsblatt ist das Arbeitsblatt, das geöffnet ist, wenn Benutzer die Arbeitsmappe speichern. 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 Excel. 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 Excel geladen und entladen wird. Verwenden Sie diese Ereignishandler zum Initialisieren des VSTO-Add-Ins, wenn es geladen wird, und zum Bereinigen von Ressourcen, die vom Add-In verwendet werden, wenn es entladen wird. Weitere Informationen finden Sie unter "Ereignisse in Office-Projekten".

So fügen Sie der gespeicherten Arbeitsmappe eine Textzeile 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 WorkbookBeforeSave -Ereignis definiert, das ausgelöst wird, wenn eine Arbeitsmappe gespeichert wird.

    Wenn der Benutzer eine Arbeitsmappe speichert, fügt der Ereignishandler am Anfang des aktiven Arbeitsblatts neuen Text hinzu.

    void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI, ref bool Cancel)
{
    Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet);
    Excel.Range firstRow = activeWorksheet.get_Range("A1");
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown);
    Excel.Range newFirstRow = activeWorksheet.get_Range("A1");
    newFirstRow.Value2 = "This text was added by using code";
}

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

    this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);

    Um die Arbeitsmappe beim Speichern zu ändern, 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 für die aktuelle Instanz von Excel steht.

  • Der Parameter Wb des Ereignishandlers für das WorkbookBeforeSave -Ereignis. Der Parameter Wb ist ein Workbook -Objekt, das für die gespeicherte Arbeitsmappe steht. Weitere Informationen finden Sie in der Excel-Objektmodellübersicht.

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 auch einen Satz von Registrierungseinträgen, mit deren Hilfe Excel 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 die Arbeitsmappe in Excel.

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

    Dieser Text wurde per Code hinzugefügt.

  4. Schließen Sie Excel.

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 Excel 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 Excel 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 Excel VSTO-Add-Ins spezifisch sind: Excel-Lösungen.

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

  • Anpassen der Benutzeroberfläche von Excel, 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 Excel: Erstellen von Office-Lösungen

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

Zugehöriger Inhalt