Office.UI interface

Ajoute un gestionnaire d’événements à l’objet à l’aide du type d’événement spécifié.

addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, options: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Ensemble de conditions requises : DialogAPI 1.2

Vous pouvez ajouter plusieurs gestionnaires d’événements pour le type d’événement spécifié tant que le nom de chaque fonction de gestionnaire d’événements est unique.

Ajoute un gestionnaire d’événements à l’objet à l’aide du type d’événement spécifié.

addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Ensemble de conditions requises : DialogAPI 1.2

Vous pouvez ajouter plusieurs gestionnaires d’événements pour le type d’événement spécifié tant que le nom de chaque fonction de gestionnaire d’événements est unique.

Exemples

// The following example shows how to add an event handler for the DialogParentMessageReceived event.
Office.onReady(() => {
    Office.context.ui.addHandlerAsync(
        Office.EventType.DialogParentMessageReceived,
        onMessageFromParent,
        onRegisterMessageComplete
    );
});

function onMessageFromParent(arg) {
    const messageFromParent = JSON.parse(arg.message);
    document.querySelector('h1').textContent = messageFromParent.name;
}

function onRegisterMessageComplete(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.log(asyncResult.error.message);
        return;
    }
}

Ferme le conteneur d’IU où le code JavaScript est exécuté.

closeContainer(): void;

Retours

Remarques

Applications : Excel, Outlook (configuration requise minimale définie : Boîte aux lettres 1.5), PowerPoint, Word

Ensembles de conditions requises :

• DialogAPI

• Mailbox 1.5

Le comportement de cette méthode est spécifié par les éléments suivants :

• Appelé à partir d’un bouton de commande sans interface utilisateur : aucun effet. Les boîtes de dialogue ouvertes par displayDialogAsync restent ouvertes.

• Appelé à partir d’un volet Office : le volet Office se ferme. Toute boîte de dialogue ouverte par displayDialogAsync se ferme également. Si le volet Office prend en charge l’épinglage et a été épinglé par l’utilisateur, il ne sera pas épinglé.

• Appelé à partir d’une extension de module : aucun effet.

Exemples

// The following example shows how to open a browser window to a download page and then close the add-in task pane.
Office.context.ui.openBrowserWindow("https://www.contoso.com/download");
Office.context.ui.closeContainer();

Affiche une boîte de dialogue pour afficher ou collecter des informations auprès de l’utilisateur ou faciliter la navigation web.

displayDialogAsync(startAddress: string, options?: DialogOptions, callback?: (result: AsyncResult<Dialog>) => void): void;

Paramètres

Retours

Remarques

Applications : Excel, Outlook, PowerPoint, Word

Ensembles de conditions requises :

• DialogAPI

• Mailbox 1.4

Cette méthode est disponible dans l’ensemble de conditions requises DialogApi pour les compléments Excel, PowerPoint ou Word, et dans l’ensemble de conditions requises boîte aux lettres 1.4 pour Outlook. Pour plus d’informations sur la façon de spécifier un ensemble de conditions requises dans votre manifeste, voir Spécifier les applications Office et les exigences d’API, si vous utilisez le manifeste de complément uniquement. Si vous utilisez le manifeste unifié pour Microsoft 365, consultez Compléments Office avec le manifeste d’application unifiée pour Microsoft 365.

La page initiale doit se trouver sur le même domaine que la page parente (paramètre startAddress). Après le chargement de la page initiale, vous pouvez également accéder à d’autres domaines.

Tout appel Office.context.ui.messageParent de page doit également se trouver sur le même domaine que la page parente.

Considérations relatives à la conception :

Les considérations de conception suivantes s’appliquent aux boîtes de dialogue.

• Un volet Office complément Office ne peut ouvrir qu’une seule boîte de dialogue à tout moment. Plusieurs boîtes de dialogue peuvent être ouvertes en même temps à partir des commandes de complément (boutons de ruban personnalisés ou éléments de menu).

• Toutes les boîtes de dialogue peuvent être déplacées et redimensionnées par l’utilisateur.

• Toutes les boîtes de dialogue s’affichent au centre de l’écran à l’ouverture.

• Les boîtes de dialogue s’affichent au-dessus de l’application et dans l’ordre dans lequel elles ont été créées.

Utilisez une boîte de dialogue pour :

• Afficher les pages d’authentification permettant de collecter les informations d’identification de l’utilisateur.

• Afficher un écran d’erreur/progression/entrée à partir d’une commande ShowTaskpane ou ExecuteAction.

• Augmenter provisoirement la surface dont un utilisateur dispose pour effectuer une tâche.

N’utilisez pas de boîte de dialogue pour interagir avec un document. Il est préférable d’utiliser un volet des tâches.

erreurs displayDialogAsync

Dans la fonction de rappel passée à la méthode displayDialogAsync, vous pouvez utiliser les propriétés de l’objet AsyncResult pour retourner les informations suivantes.

Exemples

// The following example shows how to open a dialog with a specified size. It also shows
// how to register a function to handle the message when Office.UI.messageParent() is called
// in the dialog. The implementation of the processMessage() function is omitted.

Office.context.ui.displayDialogAsync("https://www.contoso.com/myDialog.html", { height: 30, width: 20 },
    (asyncResult) => {
        const dialog = asyncResult.value;
        dialog.addEventHandler(Office.EventType.DialogMessageReceived, (arg) => {
            dialog.close();
            processMessage(arg);
        });
    }
);

// The following example does the same thing in TypeScript.

Office.context.ui.displayDialogAsync("https://www.contoso.com/myDialog.html", { height: 30, width: 20 },
    (asyncResult: Office.AsyncResult) => {
        const dialog: Office.Dialog = asyncResult.value;
        dialog.addEventHandler(Office.EventType.DialogMessageReceived, (arg: string) => {
            dialog.close();
            processMessage(arg);
        });
    }
);

Affiche une boîte de dialogue pour afficher ou collecter des informations auprès de l’utilisateur ou faciliter la navigation web.

displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;

Paramètres

Retours

Remarques

Applications : Excel, Outlook, PowerPoint, Word

Ensembles de conditions requises :

• DialogAPI

• Mailbox 1.4

Cette méthode est disponible dans l’ensemble de conditions requises DialogApi pour les compléments Excel, PowerPoint ou Word, et dans l’ensemble de conditions requises boîte aux lettres 1.4 pour Outlook. Pour plus d’informations sur la façon de spécifier un ensemble de conditions requises dans votre manifeste, voir Spécifier les applications Office et les exigences d’API, si vous utilisez le manifeste de complément uniquement. Si vous utilisez le manifeste unifié pour Microsoft 365, consultez Compléments Office avec le manifeste d’application unifiée pour Microsoft 365.

La page initiale doit se trouver sur le même domaine que la page parente (paramètre startAddress). Après le chargement de la page initiale, vous pouvez également accéder à d’autres domaines.

Tout appel Office.context.ui.messageParent de page doit également se trouver sur le même domaine que la page parente.

Considérations relatives à la conception :

Les considérations de conception suivantes s’appliquent aux boîtes de dialogue.

• Un volet Office complément Office ne peut ouvrir qu’une seule boîte de dialogue à tout moment. Plusieurs boîtes de dialogue peuvent être ouvertes en même temps à partir des commandes de complément (boutons de ruban personnalisés ou éléments de menu).

• Toutes les boîtes de dialogue peuvent être déplacées et redimensionnées par l’utilisateur.

• Toutes les boîtes de dialogue s’affichent au centre de l’écran à l’ouverture.

• Les boîtes de dialogue s’affichent au-dessus de l’application et dans l’ordre dans lequel elles ont été créées.

Utilisez une boîte de dialogue pour :

• Afficher les pages d’authentification permettant de collecter les informations d’identification de l’utilisateur.

• Afficher un écran d’erreur/progression/entrée à partir d’une commande ShowTaskpane ou ExecuteAction.

• Augmenter provisoirement la surface dont un utilisateur dispose pour effectuer une tâche.

N’utilisez pas de boîte de dialogue pour interagir avec un document. Il est préférable d’utiliser un volet des tâches.

erreurs displayDialogAsync

Dans la fonction de rappel passée à la méthode displayDialogAsync, vous pouvez utiliser les propriétés de l’objet AsyncResult pour retourner les informations suivantes.

Remet un message de la part de la boîte de dialogue à sa page parent/d’ouverture.

messageParent(message: string, messageOptions?: DialogMessageOptions): void;

Paramètres

Retours

Remarques

Applications : Excel, Outlook, PowerPoint, Word

Ensembles de conditions requises :

• DialogAPI

• Mailbox 1.4

• Si le messageOptions paramètre est utilisé, DialogOrigin 1.1 est également requis.

Exemples

// The following example shows how to send a JSON string to the parent. The profile object
// is returned from some website when a user signs into it.
function userProfileSignedIn(profile) {
    const profileMessage = {
        "name": profile.name,
        "email": profile.email,
    };
    Office.context.ui.messageParent(JSON.stringify(profileMessage));
}

Ouvre une fenêtre de navigateur et charge l’URL spécifiée.

openBrowserWindow(url: string): void;

Paramètres

Retours

Remarques

Ensemble de conditions requises : OpenBrowserWindowAPI 1.1

Exemples

// The following example shows how to open a browser window to a download page and then close the add-in task pane.
Office.context.ui.openBrowserWindow("https://www.contoso.com/download");
Office.context.ui.closeContainer();