Office.Addin interface

Paket:

office

Stellt Funktionen auf Add-In-Ebene zum Betreiben oder Konfigurieren verschiedener Aspekte des Add-Ins dar.

Hinweise

Anforderungssatz: SharedRuntime 1.1

Eigenschaften

beforeDocumentCloseNotification

Stellt ein modales Benachrichtigungsdialogfeld dar, das angezeigt werden kann, wenn der Benutzer versucht, ein Dokument zu schließen. Das Dokument wird erst geschlossen, wenn der Benutzer antwortet. Diese API wird nur in Excel unterstützt.

Methoden

getStartupBehavior()	Ruft das aktuelle Startverhalten für das Add-In ab.
hide()	Blendet den Aufgabenbereich aus.
onVisibilityModeChanged(handler)	Fügt einen Handler für das onVisibilityModeChanged -Ereignis hinzu.
setStartupBehavior(behavior)	Legt das Startverhalten für das Add-In fest, wenn das Dokument das nächste Mal geöffnet wird.
showAsTaskpane()	Zeigt den Aufgabenbereich an, der dem Add-In zugeordnet ist.

Details zur Eigenschaft

beforeDocumentCloseNotification

Stellt ein modales Benachrichtigungsdialogfeld dar, das angezeigt werden kann, wenn der Benutzer versucht, ein Dokument zu schließen. Das Dokument wird erst geschlossen, wenn der Benutzer antwortet. Diese API wird nur in Excel unterstützt.

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

Eigenschaftswert

Office.BeforeDocumentCloseNotification

Hinweise

Anforderungssatz: SharedRuntime 1.2

Details zur Methode

getStartupBehavior()

Ruft das aktuelle Startverhalten für das Add-In ab.

getStartupBehavior(): Promise<Office.StartupBehavior>;

Gibt zurück

Promise<Office.StartupBehavior>

Hinweise

Anforderungssatz: SharedRuntime 1.1

hide()

Blendet den Aufgabenbereich aus.

hide(): Promise<void>;

Gibt zurück

Promise<void>

Eine Zusage, die aufgelöst wird, wenn die Benutzeroberfläche ausgeblendet wird.

Hinweise

Anforderungssatz: SharedRuntime 1.1

onVisibilityModeChanged(handler)

Fügt einen Handler für das onVisibilityModeChanged -Ereignis hinzu.

onVisibilityModeChanged(
            handler: (message: VisibilityModeChangedMessage) => void,
        ): Promise<() => Promise<void>>;

Parameter

handler

(message: Office.VisibilityModeChangedMessage) => void

Die Handlerfunktion, die aufgerufen wird, wenn das Ereignis ausgegeben wird. Diese Funktion akzeptiert eine Nachricht für die empfangende Komponente.

Gibt zurück

Promise<() => Promise<void>>

Eine Zusage, die in eine Funktion aufgelöst wird, wenn der Handler hinzugefügt wird. Beim Aufrufen wird der Handler entfernt.

Hinweise

Anforderungssatz: SharedRuntime 1.1

Beispiele

Office.onReady(() => {
    Office.addin.onVisibilityModeChanged((args) => {
        if (args.visibilityMode === Office.VisibilityMode.taskpane) {
            // Do something when the task pane is visible.
        }
    });

    // Other startup tasks.
});

setStartupBehavior(behavior)

Legt das Startverhalten für das Add-In fest, wenn das Dokument das nächste Mal geöffnet wird.

setStartupBehavior(behavior: Office.StartupBehavior): Promise<void>;

Parameter

behavior

Office.StartupBehavior

Gibt das Startverhalten des Add-Ins an.

Gibt zurück

Promise<void>

Hinweise

Anforderungssatz: SharedRuntime 1.1

Beispiele

// Configure your add-in to load and start running when the document is opened.
Office.addin.setStartupBehavior(Office.StartupBehavior.load);

showAsTaskpane()

Zeigt den Aufgabenbereich an, der dem Add-In zugeordnet ist.

showAsTaskpane(): Promise<void>;

Gibt zurück

Promise<void>

Eine Zusage, die aufgelöst wird, wenn die Benutzeroberfläche angezeigt wird.

Hinweise

Anforderungssatz: SharedRuntime 1.1