Office.Addin interface

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. Cette API est uniquement prise en charge dans Excel.

beforeDocumentCloseNotification: BeforeDocumentCloseNotification;

Valeur de propriété

Remarques

Configuration requise définie : 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();
    });
});

Obtient le comportement de démarrage actuel du complément.

getStartupBehavior(): Promise<Office.StartupBehavior>;

Retours

Remarques

Configuration requise définie : SharedRuntime 1.1

Masque le volet Office.

hide(): Promise<void>;

Retours

Promesse résolue lorsque l’interface utilisateur est masquée.

Remarques

Configuration requise définie : SharedRuntime 1.1

Ajoute un gestionnaire pour l’événement onVisibilityModeChanged .

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

Paramètres

Retours

Promesse qui se résout en fonction lorsque le gestionnaire est ajouté. L’appeler supprime le gestionnaire.

Remarques

Configuration requise définie : SharedRuntime 1.1

Exemples

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

    // Other startup tasks.
});

Définit le comportement de démarrage du complément pour la prochaine ouverture du document.

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

Paramètres

Retours

Remarques

Configuration requise définie : SharedRuntime 1.1

Exemples

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

Affiche le volet Office associé au complément.

showAsTaskpane(): Promise<void>;

Retours

Une promesse qui est résolue lorsque l’interface utilisateur s’affiche.

Remarques

Configuration requise définie : SharedRuntime 1.1