OfficeRuntime.DisplayWebDialogOptions interface
Proporciona las opciones de visualización y las acciones que puede realizar un cuadro de diálogo.
Comentarios
Conjunto de API: CustomFunctionsRuntime 1.1
Usada por
Ejemplos
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);
Propiedades
| display |
Parámetro opcional que determina si el cuadro de diálogo se muestra como una ventana emergente (falso) o dentro de un IFrame (verdadero). Esta configuración solo se aplica a las funciones personalizadas que se ejecutan en Excel Online. |
| height | Parámetro opcional que define la altura del cuadro de diálogo como un porcentaje de la pantalla actual. Por ejemplo, acepta cadenas como: '50%', '50'. |
| on |
Devolución de llamada opcional que se ejecuta cuando se cierra el cuadro de diálogo. |
| on |
Devolución de llamada opcional que se ejecuta cuando el cuadro de diálogo envía un mensaje a su elemento primario. |
| on |
Devolución de llamada opcional que se ejecuta cuando el cuadro de diálogo envía un error. |
| width | Parámetro opcional que define el ancho del diálogo como un porcentaje de la ventana. Por ejemplo, acepta cadenas como: '50%', '50'. |
Detalles de las propiedades
displayInIFrame
Parámetro opcional que determina si el cuadro de diálogo se muestra como una ventana emergente (falso) o dentro de un IFrame (verdadero). Esta configuración solo se aplica a las funciones personalizadas que se ejecutan en Excel Online.
displayInIFrame?: boolean;Valor de propiedad
boolean
Comentarios
height
Parámetro opcional que define la altura del cuadro de diálogo como un porcentaje de la pantalla actual. Por ejemplo, acepta cadenas como: '50%', '50'.
height?: string;Valor de propiedad
string
Comentarios
onClose
Devolución de llamada opcional que se ejecuta cuando se cierra el cuadro de diálogo.
onClose?: () => void;Valor de propiedad
() => void
Comentarios
onMessage
Devolución de llamada opcional que se ejecuta cuando el cuadro de diálogo envía un mensaje a su elemento primario.
onMessage?: (message: string, dialog?: Dialog) => void;Valor de propiedad
(message: string, dialog?: OfficeRuntime.Dialog) => void
Comentarios
onRuntimeError
Devolución de llamada opcional que se ejecuta cuando el cuadro de diálogo envía un error.
onRuntimeError?: (error: Error, dialog?: Dialog) => void;Valor de propiedad
(error: Error, dialog?: OfficeRuntime.Dialog) => void
Comentarios
width
Parámetro opcional que define el ancho del diálogo como un porcentaje de la ventana. Por ejemplo, acepta cadenas como: '50%', '50'.
width?: string;Valor de propiedad
string