Erstellen Sie ein Add-In für Office Es hat sich zu einer sehr leistungsfähigen Methode entwickelt, um Word, Excel, Outlook, PowerPoint und andere Anwendungen zu erweitern. Microsoft 365 Ohne die Notwendigkeit, herkömmliche Desktop-Add-Ins zu entwickeln. Diese neuen Add-Ins basieren auf Standard-Webtechnologien und der JavaScript-API für Office und ermöglichen so die Erstellung moderner, sicherer und einfach bereitzustellender Anwendungen im gesamten Unternehmen.
In den folgenden Zeilen finden Sie eine sehr ausführliche Anleitung über Entwicklungswerkzeuge, Manifesttypen, verfügbare APIs und BereitstellungsoptionenDie offizielle Microsoft-Dokumentation wird integriert. So können Sie von Grund auf ein funktionierendes Add-In erstellen und dabei verstehen, was die einzelnen Komponenten bewirken und welche technischen Entscheidungen Sie in jedem Schritt treffen müssen.
Was ist ein modernes Office-Add-In und wie ist es aufgebaut?
Moderne Office-Add-ons Sie basieren auf der Office-Add-Ins-Plattform, die Word, Excel, PowerPoint, OneNote, Outlook und Project auf Desktop-Computern, im Web und teilweise auch auf Mobilgeräten gemeinsam ist. Sie alle verwenden dieselbe grundlegende Architektur, die aus zwei klar voneinander abgegrenzten Teilen besteht.
Das erste Teil ist das Manifest des KomplementsDiese Datei dient als „Identitätskarte“ des Add-Ins. Sie enthält die Metadaten (ID, Name, Version, Sprachen), die Office-Anwendungen, mit denen es verwendet werden kann, die benötigten Berechtigungen, die Befehle, die es dem Menüband hinzufügt, die verwendeten Symbole, den Hosting-Ort der Webanwendung und die Kontexte, in denen es aktiviert werden soll (z. B. in Outlook nur für Nachrichten oder Termine, die bestimmte Regeln erfüllen).
Das zweite Teil ist das Web-Anwendung Diese Anwendung stellt die Benutzeroberfläche und die Geschäftslogik bereit. Sie besteht aus HTML, CSS und JavaScript (oder TypeScript) und läuft in einem Office-HTML-Container (Aufgabenbereich, Inhalts-Add-In oder Dialogfeld). Dort verwendet sie die office.js-Bibliothek, um Dokumente zu lesen und zu schreiben, externe Dienste aufzurufen, die Authentifizierung zu verwalten, Dialogfelder anzuzeigen und alle anderen typischen Aufgaben einer modernen Webanwendung auszuführen.
Tools zum Erstellen von Office-Add-Ins
Es gibt keine einheitliche Methode, um ein Add-In-Projekt zu starten. Microsoft bietet an mehrere offizielle WerkzeugeDiese Tools richten sich an unterschiedliche Benutzerprofile: von Anwendern, die Visual Studio-Vorlagen bevorzugen, bis hin zu solchen, die täglich mit Node.js und Visual Studio Code arbeiten. Darüber hinaus gibt es auch Drittanbieter-Tools oder spezialisiertere Tools, wie beispielsweise UI-Editoren für VBA.
Yeoman-Generator für Office-Add-Ins
Der Yeoman-Generator für Office ist wahrscheinlich Die flexibelste Option für Webentwickler. Es ermöglicht Ihnen, Node.js-basierte Projekte zu erstellen, die Sie bearbeiten können mit Visual Studio Code oder Ihrem bevorzugten Herausgeber. Der Assistent führt Sie durch eine Reihe von Fragen, um den Typ des Add-Ins (Aufgabenbereich, Inhalts-Add-In, benutzerdefinierte Funktionen, Outlook usw.) und die Zielanwendung auszuwählen.
Mit diesem Generator können Sie Projekte erstellen für Excel, OneNote, Outlook, PowerPoint, Project, Word und benutzerdefinierte Excel-Funktionen. Darüber hinaus ermöglicht es Ihnen die Wahl zwischen einem einfachen Stack mit HTML, CSS und JavaScript/TypeScript oder einer React-basierten Architektur, ebenfalls in JavaScript oder TypeScript, wobei die gesamte Projektstruktur bereits vorbereitet ist.
Visual Studio für Office-Projekte
Wenn Sie sich bequemer bewegen in .NET-UmgebungenVisual Studio enthält spezielle Vorlagen für Office-Add-Ins. Diese Vorlagen decken hauptsächlich Excel, Outlook, Word und PowerPoint ab und erstellen eine Komplettlösung, die das Add-In-Manifest, die Webanwendung und optional zugehörige Backend-Projekte umfasst.
Das Visual Studio-Projekt Es basiert ebenfalls auf HTML, CSS und JavaScript, integriert sich aber in das klassische Microsoft-Ökosystem.Integriertes Debugging, Veröffentlichung, Paketierung usw. Es ist eine gute Wahl, wenn Sie bereits mit Unternehmenslösungen in Visual Studio arbeiten und alles zentral in derselben IDE verwalten möchten.
Microsoft 365 Agents Toolkit und Office Add-Ins Entwicklerkit
Microsoft 365 Agents Toolkit Es wurde entwickelt, um über herkömmliche Add-Ins hinauszugehen und praktisch jede Art von Erweiterung für das Microsoft 365-Ökosystem zu erstellen, indem es Bots, Teams-Erweiterungen und Add-Ins kombiniert. Mit diesem Tool können Sie Office-Add-In-Projekte generieren, die sich nahtlos in umfassendere Microsoft 365-Anwendungen einfügen.
Office Add-Ins Entwicklerkit Es handelt sich um eine Visual Studio Code-Erweiterung, die den Arbeitsalltag erheblich vereinfacht. Direkt in VS Code können Sie neue Add-In-Projekte erstellen, testbereite Codebeispiele laden und den gesamten Entwicklungszyklus verwalten, ohne den Editor zu verlassen. Die Erweiterung ist sowohl mit einheitlichen Manifesten als auch mit reinen Add-In-Manifesten kompatibel.
Das Manifest: das Herzstück der Add-in-Konfiguration
Jedes Office-Add-In wird durch eine Beschreibung beschrieben. Manifestdatei Dies teilt Anwendungen mit, wie sie die Anwendung laden, welche Schnittstellenoptionen sie bereitstellen und welche Berechtigungen sie benötigen. Es gibt zwei Hauptmanifestvorlagen; die Wahl zwischen ihnen bestimmt, wie Sie Ihr Add-In in andere Microsoft 365-Erweiterungen integrieren können.
Arten von Manifesten: Ergänzungsmanifest und einheitliches Manifest
- Manifest der ausschließlichen Komplementarität. Es handelt sich um das klassische Format für Office-Add-Ins in Excel, OneNote, Outlook, PowerPoint, Project und Word. Es ist in XML geschrieben und konzentriert sich ausschließlich auf die Beschreibung des Add-Ins, ohne es mit anderen Anwendungstypen zu vermischen.
- Einheitliches Manifest für Microsoft 365. Die Weiterentwicklung des Manifestmodells im JSON-Format, das historisch in Teams-Anwendungen verwendet wurde. Dieses Format ermöglicht es, verschiedene Arten von Microsoft 365-Erweiterungen – Office-Add-Ins, Teams-Erweiterungen usw. – in einer einzigen Anwendung zu bündeln.
Die Konfigurationslogik ist in beiden Fällen ähnlich.Sie definieren eine eindeutige Kennung (üblicherweise eine GUID), die Version, den Anzeigenamen, die Beschreibung, die unterstützten Sprachen, Symbole, Berechtigungstypen (z. B. Lesen oder Lesen/Schreiben von Dokumenten) und die Oberflächenstruktur (Registerkarten, Gruppen und Menübandschaltflächen). Außerdem legen Sie die Start-URL der Webanwendung und alle weiteren Einstellungen fest, wie z. B. Tastenkombinationen in Excel oder Word, Auslöseregeln in Outlook oder die Abmessungen von Bereichen und Inhalts-Add-Ins.
Im Manifest dargelegte Schlüsselelemente
Zusatz grundlegende MetadatenDas Manifest muss detailliert beschreiben, wie das Add-In in die Office-Umgebung integriert wird. Dies umfasst Branding-Bilder und Menüband-Befehlssymbole, die auf einem Server gehostet werden müssen, der Caching unterstützt (HTTP-Header mit …). Cache-Control: no-cache oder ähnliches für die Produktion).
Ein weiterer kritischer Aspekt ist die SicherheitAlle URLs, die auf die Webanwendung oder Add-In-Ressourcen verweisen, müssen HTTPS verwenden. Zwar sind in manchen Entwicklungsszenarien HTTP- oder selbstsignierte Zertifikate zulässig, doch wenn Sie das Add-In in Office im Web ausführen oder im Microsoft Marketplace veröffentlichen möchten, ist SSL zwingend erforderlich, um Warnungen wegen gemischter Inhalte zu vermeiden und die Datensicherheit während der Übertragung zu gewährleisten.
Wenn Sie Ihr Add-on über den Microsoft Marketplace vertreiben möchten, muss das Manifest Folgendes enthalten: Zusätzlich zur eindeutigen GUID eine zugängliche und gültige URL für den technischen Support. Microsoft wendet eine Reihe von Validierungsrichtlinien an, bei denen die Konsistenz der Manifestdaten, das Verhalten des Add-Ins und die Einhaltung der Sicherheits- und Benutzerfreundlichkeitsanforderungen überprüft werden.
Zulässige Domänen und Ursprünge für Office.js
Das Manifest kontrolliert auch Welche Domains können innerhalb des Plugin-Panels navigiert werden?In Office im Web und dem neuen Outlook für Windows kann der Aufgabenbereich nahezu jede beliebige URL laden. Bei Desktop-Anwendungen ist das Verhalten jedoch restriktiver: Versucht das Add-In, zu einer anderen Domäne als der Startseitendomäne zu navigieren, wird die URL außerhalb der Anwendung in einem separaten Browserfenster geöffnet.
Um diesen externen Sprung auf dem Desktop zu vermeidenSie können jede zusätzliche Domäne, die im Add-In-Fenster angezeigt werden soll, explizit im Manifest auflisten. Wenn die Domäne aufgeführt ist, wird sie sowohl in der Office-Desktop- als auch in der Office-Webversion im Bedienfeld geöffnet; andernfalls wird sie in der Desktopversion in einem externen Browser geöffnet.
Interaktion mit Dokumenten mithilfe der Office JavaScript API
Die Webanwendung des Add-Ins kommuniziert mit dem Office-Dokument. (oder mit der Nachricht im Fall von Outlook) über die Office JavaScript API-Bibliothek, die über das offizielle CDN von Microsoft zugänglich ist unter https://appsforoffice.microsoft.com/lib/1/hosted/office.jsVerweisen Sie einfach in dem Abschnitt auf dieses Skript. <head> von der Seite, um die verfügbaren Typen und Methoden nutzen zu können.
Sobald die Bibliothek geladen ist, stehen Ihnen zwei sich ergänzende API-Modelle zur Verfügung:
- Anwendungsspezifische APIs.
- Gängige APIs.
Jedes Modell wurde für unterschiedliche Anwendungsszenarien konzipiert, wobei sie je nach Bedarf auch im selben Zubehör kombiniert werden können.
Anwendungsspezifische APIs
Anwendungsspezifische APIs bieten stark typisierte Objekte Diese Objekte stellen native Elemente der jeweiligen Office-Anwendung dar. In Excel gibt es beispielsweise Objekte für Arbeitsblätter, Bereiche, Tabellen und Diagramme, mit denen Sie Daten strukturiert und effizient bearbeiten können.
Dieses Modell basiert auf BatchvorgängeSie verketten Aktionen innerhalb eines Kontextes und synchronisieren die Änderungen anschließend mit Office. Diese Arbeitsweise reduziert die Anzahl der Zugriffe zwischen Add-In und Anwendung und verbessert so die Leistung deutlich, insbesondere bei Office im Web.
Gemeinsame APIs für gemeinsam genutzte Funktionen
Gemeinsame APIs Sie konzentrieren sich auf übergreifende Funktionalitäten, die in mehreren Anwendungen vorhanden sind.: Schnittstellenelemente, Dialogfelder, Clienteinstellungen usw. Dieses Modell verwendet Rückruffunktionen anstelle von Promises und führt definitionsgemäß bei jedem Aufruf eine einzelne Operation an der Anwendung aus.
Mit gängigen APIs können Sie beispielsweise Je nach Anwendungsfall kann ein Popup-Dialogfeld angezeigt, die Konfiguration eines Add-Ins auf verschiedenen Hosts verwaltet oder auf bestimmte Funktionen von Outlook, PowerPoint oder Project zugegriffen werden, die noch nicht durch anwendungsspezifische APIs abgedeckt sind.
Anforderungssätze und plattformübergreifende Kompatibilität
API-Kompatibilität ist organisiert in AnforderungssätzeDiese gruppieren spezifische API-Mitglieder unter einem Versionsnamen. Es gibt anwendungsspezifische Anforderungssätze, wie zum Beispiel ExcelApi 1.7und andere gemeinsame, wie zum Beispiel DialogApi 1.1, die dort funktionieren, wo die Funktionalität von Dialogfeldern unterstützt wird.
Das Add-In kann zur Laufzeit prüfen, ob die Office-Anwendung, unter der es ausgeführt wird, die erforderlichen Systemvoraussetzungen erfüllt. Dadurch können Sie die Benutzererfahrung anpassen oder erweiterte Funktionen deaktivieren, wenn die Host-Anwendung die Mindestanforderungen nicht erfüllt, anstatt unerwartete Fehler zu verursachen.
Erkunden Sie die API mit Script Lab
Script Lab ist ein kostenloses Add-on Es dient als Testumgebung für die Office JavaScript API. Es wird über den Microsoft Marketplace installiert und läuft in Anwendungen wie Excel oder Word, sodass Sie Code-Snippets in Echtzeit im aktuellen Dokument schreiben und ausführen können.
Innerhalb von Script Lab haben Sie Zugriff auf ein Bibliothek mit sofort einsatzbereiten Beispielen, die verschiedene API-Funktionen demonstrieren.Sie können diese Code-Schnipsel als Grundlage für Ihren eigenen Code verwenden, sie modifizieren und das Ergebnis sofort im Dokument sehen, was die Prototyping- und Testphase von Funktionalitäten erheblich beschleunigt, bevor Sie diese in Ihr endgültiges Plugin integrieren.
So erweitern Sie die Office-Benutzeroberfläche
Einer der großen Vorteile von Add-Ins ist, dass sie Folgendes ermöglichen Die Funktionalität direkt in die Office-Oberfläche integrierenDamit der Benutzer nicht das Gefühl hat, die Anwendung zu „verlassen“, wird dies durch die Kombination von Plugin-Befehlen und HTML-Containern wie Aufgabenfeldern, Inhalts-Plugins und Dialogfeldern erreicht.
- Add-in-Befehle Sie dienen dazu, dem Office-Menüband benutzerdefinierte Registerkarten, neue Gruppen und zusätzliche Schaltflächen oder Menüs hinzuzufügen.
- HTML-Container (Aufgabenbereiche, Inhalts-Add-Ins und Dialoge) dienen als Oberfläche, auf der die eigene Benutzeroberfläche des Add-Ins angezeigt wird.
In einem typischen Szenario haben Sie möglicherweise einen Befehl, der in Excel eine Gruppe mit einer Schaltfläche "Daten analysieren" hinzufügt; beim Drücken dieser Schaltfläche öffnet sich rechts ein Aufgabenbereich mit Ihrer Webanwendung, die den ausgewählten Bereich analysiert, einen Machine-Learning-Dienst aufruft und die Ergebnisse durch Hervorheben von Zellen oder Erstellen von Diagrammen mithilfe der spezifischen API von Excel zurückgibt.
Erstellen eines Aufgabenbereich-Add-Ins mit Yeoman (Word-Beispiel)
Um all diese Konzepte in die Praxis umzusetzenEs ist hilfreich, anhand des Yeoman-Generators in der Praxis zu sehen, wie man ein Aufgabenbereich-Add-In für Word und Outlook erstellt. Obwohl sich die Details der Benutzeroberfläche zwischen den Anwendungen unterscheiden, sind Projektstruktur und Arbeitsablauf sehr ähnlich.
Voraussetzungen für die Entwicklungsumgebung
Vor der ProjektgenerierungSie benötigen die neueste LTS-Version von Node.js, die Sie von der offiziellen Website herunterladen können. Nach der Installation installieren Sie Yeoman und den Office-Generator global mit dem folgenden Befehl: npm install -g yo generator-officeStellen Sie abschließend sicher, dass Ihr Office-Abonnement mit einem Microsoft 365-Abonnement verknüpft ist, das Office im Web beinhaltet, da Sie das Add-In sowohl auf dem Desktop als auch im Browser testen werden.
Erstellen eines Word-Add-Ins mit einem Aufgabenbereich
Der erste Schritt ist die Art des Manifests festlegen Welche Option Sie verwenden möchten, hängt davon ab, ob Sie Ihr Add-in mit anderen Erweiterungen in einer einzigen App kombinieren möchten oder nicht. Sobald Sie sich entschieden haben, führen Sie Folgendes aus: yo office im Arbeitsverzeichnis.
Während der interaktiver AssistentSie können beispielsweise einen Projekttyp auswählen, einen Namen wie „Mein Office-Add-In“ vergeben und Word als Zielanwendung festlegen. Anschließend erstellt der Generator den Projektordner, installiert die Node-Abhängigkeiten und bereitet alles für den Einsatz vor.
Innerhalb der Projektmappe finden Sie die Manifestdatei (manifest.json o manifest.xml) im Stammverzeichnis, das die Plugin-Konfiguration definiert; die Datei ./src/taskpane/taskpane.html mit dem Aufgabenbereichs-Markup; das CSS in ./src/taskpane/taskpane.css; und der Code, der die Office-API aufruft in ./src/taskpane/taskpane.ts o .jsje nachdem, ob Sie sich für TypeScript oder JavaScript entschieden haben.
Um das Add-In in der Desktop-Version von Word zu testenSie müssen lediglich zum Stammverzeichnis des Projekts navigieren (cd "My Office Add-in"und ausführen npm startDieser Befehl startet den lokalen Webserver und Word mit dem bereits im Sideloading-Modus geladenen Add-In. Wenn Sie es lieber in Word im Web ausprobieren möchten, können Sie einen Befehl wie diesen verwenden: npm run start -- web --document {url}, indem die URL durch die URL eines in OneDrive oder SharePoint gespeicherten Dokuments ersetzt wird.
Entwicklungsserver und Abhängigkeitsverwaltung
Während der Entwicklung ist es üblich erlangte das npm install Es kann während des automatischen Schritts, den Yeoman ausführt, zu einem Fehler kommen, insbesondere bei Konflikten mit Abhängigkeitsversionen. In diesen Fällen wechseln Sie einfach in den Projektordner und starten Sie den Vorgang. npm install manuell zu lösen.
Wenn Warnungen über veraltete Abhängigkeiten erscheinenAuf das Werkzeug können Sie sich verlassen. npm-check-updates, die Installation mit npm i -g npm-check-updates, ausführen ncu -u um Versionsbereiche zu aktualisieren in package.json und den Prozess mit einem neuen npm installViele dieser Warnungen sind nicht kritisch, aber es ist ratsam, sie regelmäßig zu überprüfen, um den Zustand des Projekts zu erhalten.
Den Entwicklungsserver stoppen und das Plugin im Sideloading-Modus deinstallieren, können Sie Folgendes ausführen: npm stop im Stammverzeichnis. Wenn Sie das Add-In zuvor manuell hochgeladen haben (z. B. durch Hochladen des Manifests in Office on the Web), müssen Sie es auch manuell über die entsprechende Verwaltungsoberfläche entfernen.
Von der grundlegenden Struktur eines Add-Ins und den Entwicklungswerkzeugen (Yeoman, Visual Studio, Agents Toolkit, Script Lab) bis hin zur Rolle des Manifests, der JavaScript-APIs, der Sicherheitskontrollen und der Bereitstellungsoptionen (lokal, Marketplace, zentralisierte Bereitstellung oder über Anbieter wie Qlik) haben Sie eine ziemlich vollständige Karte um zu entscheiden, welche Art von Add-on Sie benötigen, wie Sie es entwickeln und wie Sie es Ihren Benutzern ohne technische Überraschungen zur Verfügung stellen können.