Automatisches Öffnen eines Aufgabenbereichs bei Installation eines Add-Ins

Sie können den Aufgabenbereich Ihres Add-Ins so konfigurieren, dass es sofort nach der Installation gestartet wird. Dieses Feature erhöht die Nutzung.

Tipp

In diesem Artikel wird eine Funktion beschrieben, die es einem Add-In ermöglicht, seinen Aufgabenbereich zu öffnen , wenn das Add-In von einem Endbenutzer installiert wird. Dieses Feature ist auf ein einzelnes Dokument beschränkt: das Dokument, das bei der Installation des Add-Ins geöffnet ist. Dieses Feature unterscheidet sich von drei ähnlichen Features:

  • Ein Add-In kann ein Dokument programmgesteuert so konfigurieren, dass der Aufgabenbereich des Add-Ins automatisch geöffnet wird, wenn das Dokument geöffnet wird. Die Technik hat einen Dokumentenbereich, was bedeutet, dass sie auf jedes Dokument einzeln angewendet werden muss. Weitere Informationen finden Sie unter Automatisches Öffnen eines Aufgabenbereichs mit einem Dokument.
  • Ein Add-In kann sich programmgesteuert so konfigurieren, dass beim Öffnen eines Dokuments Code ausgeführt wird. Dieses Feature muss auch auf jedes Dokument einzeln angewendet werden. Weitere Informationen finden Sie unter Konfigurieren eines Dokuments zum Ausführen von Code beim Öffnen.
  • Ein Add-In kann im Manifest zum Ausführen von Code beim Öffnen eines Dokuments konfiguriert werden. Dieses Feature hat Office-Anwendungsbereich. Nachdem ein Add-In von einem Microsoft 365-Administrator im Admin-Portal des Microsoft 365-Mandanten installiert wurde, startet das Add-In Code für jedes Office-Dokument, das in den Office-Anwendungen geöffnet wird, für die das Add-In im Manifest konfiguriert ist, und führt Code aus. Weitere Informationen finden Sie unter Aktivieren von Add-Ins mit Ereignissen, insbesondere die Informationen zum OnDocumentOpened Ereignis.

Standardmäßig öffnen Aufgabenbereich-Add-Ins, die keineAdd-In-Befehle enthalten, den Aufgabenbereich sofort nach der Installation. Wenn ein Add-In jedoch über einen oder mehrere Add-In-Befehle verfügt, wird der Benutzer über das neue Add-In benachrichtigt, das Add-In wird jedoch nicht automatisch gestartet. Dieses frühere Standardverhalten ändert sich, sodass Add-Ins, die über Add-In-Befehle verfügen, in einigen Situationen automatisch gestartet werden. Wenn das Add-In über mehrere Aufgabenbereichsseiten verfügt, können Sie außerdem steuern, ob das Add-In bei der Installation gestartet wird und, falls ja, welche Seite im Aufgabenbereich geöffnet wird.

Hinweis

  • Dieses Feature gilt nur für Add-Ins, die von einem Endbenutzer installiert wurden, nicht für zentral bereitgestellte Add-Ins.
  • Dieses Feature gilt nicht für Inhalts-Add-Ins oder Mail-Add-Ins (Outlook).
  • Dieses Feature gilt nur für Add-Ins, die über mindestens einen Add-In-Befehl des Typs "Aufgabenbereichsbefehl" verfügen.

Neues Verhalten

Das neue Verhalten ist wie folgt:

  • Wenn das Add-In nur über einen Aufgabenbereichsbefehl verfügt, ist die Menüband-Registerkarte des Add-Ins ausgewählt, und der Aufgabenbereich wird bei der Installation automatisch geöffnet. Sie müssen nichts konfigurieren.
  • Wenn das Add-In über mehrere Aufgabenbereichsbefehle verfügt und einer als Standard konfiguriert ist (siehe Standardaufgabenbereich konfigurieren), ist die Menüband-Registerkarte des Add-Ins ausgewählt, und der Standardaufgabenbereich wird bei der Installation automatisch geöffnet.
  • Wenn das Add-In über mehrere Aufgabenbereichsbefehle verfügt, aber keiner als Standard konfiguriert ist, wird die Registerkarte Menüband des Add-Ins bei der Installation automatisch ausgewählt, und es wird eine Legende in der Nähe angezeigt, die den Benutzer über das neue Add-In informiert. Es wird jedoch kein Aufgabenbereich geöffnet. Dies entspricht dem bisherigen Standardverhalten.

Hinweis

Wenn der Add-In-Befehl, der den Aufgabenbereich startet, aus irgendeinem Grund nicht vom Benutzer beim Start manuell ausgewählt werden kann, z. B. wenn er beim Start deaktiviert ist , wird er unabhängig von der Konfiguration nicht automatisch geöffnet.

Konfigurieren des Standardaufgabenbereichs im Manifest

Der Prozess zum Angeben des Standardaufgabenbereichs hängt von dem Manifesttyp ab, den das Add-In verwendet.

Um den Standardaufgabenbereich anzugeben, suchen Sie das Laufzeitobjekt im "runtimes" Array, dessen "code.page" Eigenschaft auf die URL der Seite festgelegt ist, die Sie als Standard festlegen möchten. Stellen Sie sicher, dass das "actions" Array in demselben Laufzeitobjekt mindestens eine Aktion mit dem "type" Wert "openPage". Fügen Sie diesem Aktionsobjekt eine "view" Eigenschaft hinzu, und legen Sie sie auf "Office.AutoShowTaskpaneWithDocument"fest. Sie können diesen Wert nur für ein Aktionsobjekt festlegen, und es muss sich um eine Aktion vom Typ "openPage". Wenn Sie diesen Wert für mehrere Aktionen festlegen, wird das erste Vorkommen des Werts als Standard erkannt, und alle anderen werden ignoriert.

Im folgenden Beispiel wird ein "view" Wert angezeigt, der auf festgelegt ist "Office.AutoShowTaskpaneWithDocument".

"runtimes": [
    {
        ...
        "code": {
            "page": "https://contoso.com/taskpane.html"
        },
        "actions": [
            {
                "id": "ShowTaskPane",
                "type": "openPage",
                "view": "Office.AutoShowTaskpaneWithDocument"
            }
        ]
    }
]

Tipp

Wenn Ihr Add-In automatisch gestartet werden soll, wenn der Benutzer das Dokument erneut öffnet, müssen Sie weitere Konfigurationsschritte durchführen. Details und Hinweise dazu, wann dieses Feature verwendet werden sollte, finden Sie unter Automatisches Öffnen eines Aufgabenbereichs mit einem Dokument.

Siehe auch

  • Zuletzt aktualisiert um