Office.DialogOptions interface

  • Référence
Paquet:
office

Fournit des options pour l’affichage d’une boîte de dialogue.

Propriétés

asyncContext

Élément défini par l’utilisateur de tout type retourné, inchangé, dans la propriété asyncContext de l’objet AsyncResult passé à un rappel.
displayInIframe

Détermine si la boîte de dialogue doit être affichée dans un IFrame. Ce paramètre s’applique uniquement dans Office sur le Web et est ignoré par d’autres plateformes. Si la valeur est false (valeur par défaut), la boîte de dialogue s’affiche sous la forme d’une nouvelle fenêtre de navigateur (fenêtre contextuelle). Recommandé pour les pages d’authentification qui ne peuvent pas être affichées dans un IFrame. Si la valeur est true, la boîte de dialogue s’affiche sous la forme d’une superposition flottante avec un IFrame. Recommandé pour une expérience utilisateur et des performances optimales.
height

Définit la hauteur de la boîte de dialogue sous forme de pourcentage de l’affichage actuel. Valeur par défaut : 80 %. 250 px minimum.
promptBeforeOpen

Détermine si la boîte de dialogue du bloqueur de fenêtres contextuelles sera affichée à l’utilisateur. La valeur par défaut est true.

true -L’infrastructure affiche une fenêtre contextuelle pour déclencher la navigation et éviter le bloqueur de fenêtres publicitaires du navigateur. false -La boîte de dialogue n’est pas affichée et le développeur doit gérer les fenêtres contextuelles (en fournissant un artefact d’interface utilisateur pour déclencher la navigation).
width

Définit la largeur de la boîte de dialogue sous forme de pourcentage de l’affichage actuel. Valeur par défaut : 80 %. 150 px minimum.

Détails de la propriété

asyncContext

Élément défini par l’utilisateur de tout type retourné, inchangé, dans la propriété asyncContext de l’objet AsyncResult passé à un rappel.

asyncContext?: any

Valeur de propriété

any

displayInIframe

Détermine si la boîte de dialogue doit être affichée dans un IFrame. Ce paramètre s’applique uniquement dans Office sur le Web et est ignoré par d’autres plateformes. Si la valeur est false (valeur par défaut), la boîte de dialogue s’affiche sous la forme d’une nouvelle fenêtre de navigateur (fenêtre contextuelle). Recommandé pour les pages d’authentification qui ne peuvent pas être affichées dans un IFrame. Si la valeur est true, la boîte de dialogue s’affiche sous la forme d’une superposition flottante avec un IFrame. Recommandé pour une expérience utilisateur et des performances optimales.

displayInIframe?: boolean

Valeur de propriété

boolean

height

Définit la hauteur de la boîte de dialogue sous forme de pourcentage de l’affichage actuel. Valeur par défaut : 80 %. 250 px minimum.

height?: number,

Valeur de propriété

number

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 and how to use that handler to close 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);
        });
    }
);

promptBeforeOpen

Détermine si la boîte de dialogue du bloqueur de fenêtres contextuelles sera affichée à l’utilisateur. La valeur par défaut est true.

true -L’infrastructure affiche une fenêtre contextuelle pour déclencher la navigation et éviter le bloqueur de fenêtres publicitaires du navigateur. false -La boîte de dialogue n’est pas affichée et le développeur doit gérer les fenêtres contextuelles (en fournissant un artefact d’interface utilisateur pour déclencher la navigation).

promptBeforeOpen?: boolean;

Valeur de propriété

boolean

width

Définit la largeur de la boîte de dialogue sous forme de pourcentage de l’affichage actuel. Valeur par défaut : 80 %. 150 px minimum.

width?: number,

Valeur de propriété

number

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 and how to use that handler to close 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);
        });
    }
);