Office.BeforeDocumentCloseNotification interface

  • Referenz
Paket:
office

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. Im Benachrichtigungsdialogfeld kann der Benutzer die Anforderung zum Schließen des Dokuments bestätigen oder die Anforderung zum Schließen des Dokuments abbrechen. Diese API wird nur in Excel unterstützt.

Hinweise

Anforderungssatz: SharedRuntime 1.2

Beispiele

// Enable the before document close modal notification dialog. 
async function enableNotification() {
    await Office.addin.beforeDocumentCloseNotification.enable(); 
}

// Add an event handler to detect when the document close operation is cancelled.
Office.addin.beforeDocumentCloseNotification.onCloseActionCancelled(async function () {
    // When the document close attempt is cancelled, write a message to the active range in the worksheet.
    await Excel.run(async (context) => {
        const range = context.workbook.getSelectedRange();
        range.values = [["Detected onCloseActionCancelled event."]];
        await context.sync();
    });
});

Methoden

disable()

Verhindert, dass das Benachrichtigungsdialogfeld angezeigt wird, wenn der Benutzer versucht, ein Dokument zu schließen. Die BeforeDocumentCloseNotification API wird nur in Excel unterstützt.
enable()

Aktivieren Sie ein modales Benachrichtigungsdialogfeld, das angezeigt wird, wenn der Benutzer versucht, ein Dokument zu schließen. Das Dokument wird erst geschlossen, wenn der Benutzer antwortet. In diesem Benachrichtigungsdialogfeld wird der Benutzer aufgefordert, die Anforderung zum Schließen des Dokuments zu bestätigen, oder der Benutzer kann die Anforderung zum Schließen des Dokuments abbrechen. Die BeforeDocumentCloseNotification API wird nur in Excel unterstützt.
onCloseActionCancelled(handler)

Fügt einen Ereignishandler hinzu, der erkennt, wenn der BeforeDocumentCloseNotification Schließvorgang abgebrochen wird. Dieser Ereignishandler wird ausgelöst, wenn die beiden folgenden Bedingungen erfüllt sind.

  1. Das Add-In ruft die enable -Methode für das BeforeDocumentCloseNotification -Objekt auf.

  2. Wenn das Benachrichtigungsdialogfeld geöffnet ist, klickt der Endbenutzer im Dialogfeld auf die Schaltfläche Nicht schließen , klickt in der oberen rechten Ecke des Dialogfelds auf die Schaltfläche Schließen oder drückt die ESC-TASTE.

Die BeforeDocumentCloseNotification API wird nur in Excel unterstützt.

Details zur Methode

disable()

Verhindert, dass das Benachrichtigungsdialogfeld angezeigt wird, wenn der Benutzer versucht, ein Dokument zu schließen. Die BeforeDocumentCloseNotification API wird nur in Excel unterstützt.

disable(): Promise<void>;

Gibt zurück

Promise<void>

Hinweise

Anforderungssatz: SharedRuntime 1.2

enable()

Aktivieren Sie ein modales Benachrichtigungsdialogfeld, das angezeigt wird, wenn der Benutzer versucht, ein Dokument zu schließen. Das Dokument wird erst geschlossen, wenn der Benutzer antwortet. In diesem Benachrichtigungsdialogfeld wird der Benutzer aufgefordert, die Anforderung zum Schließen des Dokuments zu bestätigen, oder der Benutzer kann die Anforderung zum Schließen des Dokuments abbrechen. Die BeforeDocumentCloseNotification API wird nur in Excel unterstützt.

enable(): Promise<void>;

Gibt zurück

Promise<void>

Hinweise

Anforderungssatz: SharedRuntime 1.2

onCloseActionCancelled(handler)

Fügt einen Ereignishandler hinzu, der erkennt, wenn der BeforeDocumentCloseNotification Schließvorgang abgebrochen wird. Dieser Ereignishandler wird ausgelöst, wenn die beiden folgenden Bedingungen erfüllt sind.

  1. Das Add-In ruft die enable -Methode für das BeforeDocumentCloseNotification -Objekt auf.

  2. Wenn das Benachrichtigungsdialogfeld geöffnet ist, klickt der Endbenutzer im Dialogfeld auf die Schaltfläche Nicht schließen , klickt in der oberen rechten Ecke des Dialogfelds auf die Schaltfläche Schließen oder drückt die ESC-TASTE.

Die BeforeDocumentCloseNotification API wird nur in Excel unterstützt.

onCloseActionCancelled(
            handler: () => void
        ): Promise<() => Promise<void>>;

Parameter

handler

() => void

Der Ereignishandler, der aufgerufen wird, wenn der Dialog abgebrochen wird.

Gibt zurück

Promise<() => Promise<void>>

Eine Zusage, die aufgelöst wird, wenn der Ereignishandler hinzugefügt wird.

Hinweise

Anforderungssatz: SharedRuntime 1.2