Office.BeforeDocumentCloseNotification interface

  • Référence
Paquet:
office

Représente une boîte de dialogue de notification modale qui peut s’afficher lorsque l’utilisateur tente de fermer un document. Le document ne se ferme pas tant que l’utilisateur n’a pas répondu. La boîte de dialogue de notification permet à l’utilisateur de confirmer la demande de fermeture du document ou d’annuler la demande de fermeture du document. Cette API est uniquement prise en charge dans Excel.

Remarques

Ensemble de conditions requises : SharedRuntime 1.2

Exemples

// 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();
    });
});

Méthodes

disable()

Empêche l’affichage de la boîte de dialogue de notification lorsque l’utilisateur tente de fermer un document. L’API BeforeDocumentCloseNotification est uniquement prise en charge dans Excel.
enable()

Activez une boîte de dialogue de notification modale qui s’affiche lorsque l’utilisateur tente de fermer un document. Le document ne se ferme pas tant que l’utilisateur n’a pas répondu. Cette boîte de dialogue de notification demande à l’utilisateur de confirmer la demande de fermeture du document ou lui permet d’annuler la demande de fermeture du document. L’API BeforeDocumentCloseNotification est uniquement prise en charge dans Excel.
onCloseActionCancelled(handler)

Ajoute un gestionnaire d’événements qui détecte quand l’opération BeforeDocumentCloseNotification de fermeture est annulée. Ce gestionnaire d’événements est déclenché si les deux conditions suivantes sont remplies.

  1. Le complément appelle la enable méthode sur l’objet BeforeDocumentCloseNotification .

  2. Lorsque la boîte de dialogue de notification est ouverte, l’utilisateur final clique sur le bouton Ne pas fermer dans la boîte de dialogue, clique sur le bouton Fermer dans le coin supérieur droit de la boîte de dialogue ou appuie sur la touche Échap.

L’API BeforeDocumentCloseNotification est uniquement prise en charge dans Excel.

Détails de la méthode

disable()

Empêche l’affichage de la boîte de dialogue de notification lorsque l’utilisateur tente de fermer un document. L’API BeforeDocumentCloseNotification est uniquement prise en charge dans Excel.

disable(): Promise<void>;

Retours

Promise<void>

Remarques

Ensemble de conditions requises : SharedRuntime 1.2

enable()

Activez une boîte de dialogue de notification modale qui s’affiche lorsque l’utilisateur tente de fermer un document. Le document ne se ferme pas tant que l’utilisateur n’a pas répondu. Cette boîte de dialogue de notification demande à l’utilisateur de confirmer la demande de fermeture du document ou lui permet d’annuler la demande de fermeture du document. L’API BeforeDocumentCloseNotification est uniquement prise en charge dans Excel.

enable(): Promise<void>;

Retours

Promise<void>

Remarques

Ensemble de conditions requises : SharedRuntime 1.2

onCloseActionCancelled(handler)

Ajoute un gestionnaire d’événements qui détecte quand l’opération BeforeDocumentCloseNotification de fermeture est annulée. Ce gestionnaire d’événements est déclenché si les deux conditions suivantes sont remplies.

  1. Le complément appelle la enable méthode sur l’objet BeforeDocumentCloseNotification .

  2. Lorsque la boîte de dialogue de notification est ouverte, l’utilisateur final clique sur le bouton Ne pas fermer dans la boîte de dialogue, clique sur le bouton Fermer dans le coin supérieur droit de la boîte de dialogue ou appuie sur la touche Échap.

L’API BeforeDocumentCloseNotification est uniquement prise en charge dans Excel.

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

Paramètres

handler

() => void

Gestionnaire d’événements appelé lorsque la boîte de dialogue est annulée.

Retours

Promise<() => Promise<void>>

Promesse qui se résout lorsque le gestionnaire d’événements est ajouté.

Remarques

Ensemble de conditions requises : SharedRuntime 1.2