OfficeRuntime.DisplayWebDialogOptions interface
Fournit des options d’affichage et des actions qu’une boîte de dialogue peut effectuer.
Remarques
Jeu d’API : CustomFunctionsRuntime 1.1
Utilisateur
Exemples
const dialogUrl = "https://your-addin-domain.com/dialog.html";
const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = {
height: "50%",
width: "50%",
displayInIFrame: false,
onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) {
dialog?.close();
console.log("Dialog result: " + message);
},
onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) {
dialog?.close();
console.log("Dialog error: " + error.message);
},
}
OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions);
Propriétés
| display |
Paramètre facultatif qui détermine si la boîte de dialogue s’affiche sous forme de fenêtre contextuelle (false) ou dans un IFrame (true). Ce paramètre s’applique uniquement aux fonctions personnalisées exécutées sur Excel Online. |
| height | Paramètre facultatif qui définit la hauteur de la boîte de dialogue sous forme de pourcentage de l’affichage actuel. Par exemple, accepte des chaînes telles que : « 50 % », « 50 ». |
| on |
Rappel facultatif qui s’exécute lorsque la boîte de dialogue est fermée. |
| on |
Rappel facultatif qui s’exécute lorsque la boîte de dialogue envoie un message à son parent. |
| on |
Rappel facultatif qui s’exécute lorsque la boîte de dialogue envoie une erreur. |
| width | Paramètre facultatif qui définit la largeur de la boîte de dialogue sous forme de pourcentage de la fenêtre. Par exemple, accepte des chaînes telles que : « 50 % », « 50 ». |
Détails de la propriété
displayInIFrame
Paramètre facultatif qui détermine si la boîte de dialogue s’affiche sous forme de fenêtre contextuelle (false) ou dans un IFrame (true). Ce paramètre s’applique uniquement aux fonctions personnalisées exécutées sur Excel Online.
displayInIFrame?: boolean;Valeur de propriété
boolean
Remarques
height
Paramètre facultatif qui définit la hauteur de la boîte de dialogue sous forme de pourcentage de l’affichage actuel. Par exemple, accepte des chaînes telles que : « 50 % », « 50 ».
height?: string;Valeur de propriété
string
Remarques
onClose
Rappel facultatif qui s’exécute lorsque la boîte de dialogue est fermée.
onClose?: () => void;Valeur de propriété
() => void
Remarques
onMessage
Rappel facultatif qui s’exécute lorsque la boîte de dialogue envoie un message à son parent.
onMessage?: (message: string, dialog?: Dialog) => void;Valeur de propriété
(message: string, dialog?: OfficeRuntime.Dialog) => void
Remarques
onRuntimeError
Rappel facultatif qui s’exécute lorsque la boîte de dialogue envoie une erreur.
onRuntimeError?: (error: Error, dialog?: Dialog) => void;Valeur de propriété
(error: Error, dialog?: OfficeRuntime.Dialog) => void
Remarques
width
Paramètre facultatif qui définit la largeur de la boîte de dialogue sous forme de pourcentage de la fenêtre. Par exemple, accepte des chaînes telles que : « 50 % », « 50 ».
width?: string;Valeur de propriété
string