Erste Schritte zur Entwicklung von benutzerdefinierten Excel-Funktionen

  • Artikel

Mithilfe benutzerdefinierter Funktionen können Entwickler Excel neue Funktionen hinzufügen, indem sie diese in JavaScript oder TypeScript als Teil eines Add-Ins definieren. Excel-Benutzer können auf benutzerdefinierte Funktionen auf die gleiche Weise zugreifen wie auf die nativen Funktionen in Excel (beispielsweise SUM()).

Voraussetzungen

  • Node.js (die aktuellsteLTS-Version). Besuchen Sie die Node.js Website , um die richtige Version für Ihr Betriebssystem herunterzuladen und zu installieren.

  • Die neueste Version von Yeoman und des Yeoman-Generators für Office-Add-Ins. Um diese Tools global zu installieren, führen Sie den folgenden Befehl an der Eingabeaufforderung aus.

    npm install -g yo generator-office

    Hinweis

    Selbst wenn Sie bereits den Yeoman-Generator installiert haben, empfehlen wir Ihnen, das npm-Paket auf die neueste Version zu aktualisieren.

  • Office in Verbindung mit einem Microsoft 365-Abonnement (einschließlich Office im Internet).

    Hinweis

    Wenn Sie noch nicht über Office verfügen, können Sie sich über das Microsoft 365-Entwicklerprogramm für ein Microsoft 365 E5-Entwicklerabonnement qualifizieren. Weitere Informationen finden Sie in den häufig gestellten Fragen. Alternativ können Sie sich für eine kostenlose 1-monatige Testversion registrieren oder einen Microsoft 365-Plan erwerben.

Erstellen des ersten Projekts für benutzerdefinierte Funktionen

Verwenden Sie zum Starten den Yeoman-Generator, um das Projekt für benutzerdefinierte Funktionen zu erstellen. So wird Ihr Projekt mit der richtigen Ordnerstruktur, den Quelldateien und Abhängigkeiten eingerichtet, sodass Sie mit der Codierung Ihrer benutzerdefinierten Funktionen beginnen können.

  1. Führen Sie den folgenden Befehl aus, um ein Add-In-Projekt mit dem Yeoman-Generator zu erstellen: Ein Ordner, der das Projekt enthält, wird dem aktuellen Verzeichnis hinzugefügt.

    yo office

    Hinweis

    Wenn Sie den yo office-Befehl ausführen, werden möglicherweise Eingabeaufforderungen zu den Richtlinien für die Datensammlung von Yeoman und den CLI-Tools des Office-Add-In angezeigt. Verwenden Sie die bereitgestellten Informationen, um auf die angezeigten Eingabeaufforderungen entsprechend zu reagieren.

    Wenn Sie dazu aufgefordert werden, geben Sie die folgenden Informationen an, um das Add-In-Projekt zu erstellen:

    • Wählen Sie einen Projekttyp aus:Excel Custom Functions using a Shared Runtime
    • Wählen Sie einen Skripttyp aus:JavaScript
    • Wie möchten Sie Ihr Add-In benennen?My custom functions add-in

    Die Befehlszeilenschnittstelle des Yeoman Office-Add-In-Generators fordert sie für Projekte mit benutzerdefinierten Funktionen auf.

    Der Yeoman-Generator erstellt die Projektdateien und installiert die unterstützenden Node-Komponenten.

  2. Der Yeoman-Generator erteilt Ihnen in der Befehlszeile einige Anweisungen zum Projekt, aber ignorieren Sie diese und befolgen Sie weiterhin unsere Anweisungen. Navigieren Sie zum Stammordner des Projekts.

    cd "My custom functions add-in"

  3. Erstellen Sie das Projekt.

    npm run build

  4. Starten Sie den lokalen Webserver, auf dem Node.js ausgeführt wird. Sie können das Add-In für benutzerdefinierte Funktionen in Excel ausprobieren. Möglicherweise werden Sie aufgefordert, den Aufgabenbereich des Add-Ins zu öffnen, dies ist jedoch optional. Sie können weiterhin benutzerdefinierte Funktionen ausführen, ohne den Aufgabenbereich des Add-Ins zu öffnen.

Führen Sie den folgenden Befehl aus, um das Add-In in Excel unter Windows oder Mac zu testen. Wenn Sie diesen Befehl ausführen, wird der lokale Webserver gestartet, und Excel mit geladenem Add-In geöffnet.

npm run start:desktop

Hinweis

Office-Add-Ins sollten auch während der Entwicklung HTTPS und nicht HTTP verwenden. Wenn Sie aufgefordert werden, ein Zertifikat zu installieren, nachdem Sie einen der folgenden Befehle ausgeführt haben, akzeptieren Sie die Eingabeaufforderung, um das Zertifikat zu installieren, das der Yeoman-Generator bereitstellt. Möglicherweise ist es auch erforderlich, dass Sie Ihre Eingabeaufforderung oder Ihr Terminal als Administrator ausführen, damit die Änderungen vorgenommen werden können.

Testen einer vorgefertigten benutzerdefinierten Funktion

Das Projekt für benutzerdefinierte Funktionen, das Sie mithilfe des Yeoman-Generators erstellt haben, enthält einige vordefinierte benutzerdefinierte Funktionen. Diese sind in der Datei ./src/functions/functions.js definiert. Die Datei ./manifest.xml im Stammverzeichnis des Projekts gibt an, dass alle benutzerdefinierten Funktionen zum Namespace CONTOSO gehören.

Testen Sie in Ihrer Excel-Arbeitsmappe die benutzerdefinierte Funktion ADD, indem Sie die folgenden Schritte ausführen.

  1. Wählen Sie eine Zelle aus, und geben Sie =CONTOSO ein. Beachten Sie, dass das Menü „AutoVervollständigen“ eine Liste mit allen Funktionen im Namespace CONTOSO anzeigt.

  2. Führen Sie die Funktion CONTOSO.ADD mit den Zahlen 10 und 200 als Eingabeparameter aus, indem Sie den Wert =CONTOSO.ADD(10,200) in der Zelle angeben und die EINGABETASTE drücken.

Die benutzerdefinierte Funktion ADD berechnet die Summe der beiden Zahlen, die Sie als Eingabeparameter angeben. Die Eingabe =CONTOSO.ADD(10,200) sollte nach dem Drücken der EINGABETASTE das Ergebnis 210 in der Zelle ausgeben.

Wenn der CONTOSO Namespace im Menü "AutoVervollständigen" nicht verfügbar ist, führen Sie die folgenden Schritte aus, um das Add-In in Excel zu registrieren.

  1. Wählen Sie imExcel-Menüband Start-Add-Ins> aus.

  2. Wählen Sie im Abschnitt Entwickler-Add-Insdie Option Mein Add-In für benutzerdefinierte Funktionen aus, um es zu registrieren.

    Das Dialogfeld

Nächste Schritte

Sie haben erfolgreich eine benutzerdefinierte Funktion in einem Excel-Add-In erstellt. Erstellen Sie als Nächstes ein komplexes Add-In mit der Funktion "Streamingdaten". Der folgende Link führt Sie durch die nächsten Schritte im Lernprogramm für ein Excel-Add-In mit benutzerdefinierten Funktionen.

Lernprogramm für Excel-Add-In mit benutzerdefinierten Funktionen

Problembehandlung

Wenn Sie den Schnellstart mehrmals ausführen, können Probleme auftreten. Wenn der Office-Cache bereits über eine Instanz einer Funktion mit demselben Namen verfügt, erhält Ihr Add-In beim Querladen einen Fehler. Sie können dies verhindern, indem Sie den Office-Cache löschen, bevor Sie npm run start ausführen.

Eine Fehlermeldung in Excel mit dem Titel „Fehler beim Installieren von Funktionen“. Sie enthält den Text „Dieses Add-In wurde nicht installiert, weil bereits eine benutzerdefinierte Funktion mit demselben Namen vorhanden ist“.

Siehe auch