Office.DialogOptions interface

Paquete:

office

Proporciona opciones para cómo se muestra un cuadro de diálogo.

Propiedades

asyncContext	Elemento definido por el usuario de cualquier tipo que se devuelve, sin cambios, en la propiedad asyncContext del objeto AsyncResult que se pasa a una devolución de llamada.
displayInIframe	Determina si se debe mostrar el cuadro de diálogo dentro de un IFrame. Esta configuración solo es aplicable en Office en la Web y otras plataformas lo omiten. Si es false (valor predeterminado), el cuadro de diálogo se mostrará como una nueva ventana del explorador (ventana emergente). Se recomienda para las páginas de autenticación que no se pueden mostrar en un IFrame. Si es true, el cuadro de diálogo se mostrará como una superposición flotante con un IFrame. Es la mejor opción para mejorar el rendimiento y la experiencia del usuario.
height	Define la altura del cuadro de diálogo como porcentaje de la pantalla actual. El valor predeterminado es 80 %. 250 px como mínimo.
promptBeforeOpen	Determina si el cuadro de diálogo del bloqueador emergente se mostrará al usuario. El valor predeterminado es true. true: el marco muestra una ventana emergente para desencadenar la navegación y evitar el bloqueador de ventanas emergentes del explorador. false: no se mostrará el cuadro de diálogo y el desarrollador debe controlar las ventanas emergentes (proporcionando un artefacto de la interfaz de usuario para activar el panel de navegación).
width	Define el ancho del cuadro de diálogo como porcentaje de la pantalla actual. El valor predeterminado es 80 %. 150 px como mínimo.

Detalles de las propiedades

asyncContext

Elemento definido por el usuario de cualquier tipo que se devuelve, sin cambios, en la propiedad asyncContext del objeto AsyncResult que se pasa a una devolución de llamada.

asyncContext?: any

Valor de propiedad

any

displayInIframe

Determina si se debe mostrar el cuadro de diálogo dentro de un IFrame. Esta configuración solo es aplicable en Office en la Web y otras plataformas lo omiten. Si es false (valor predeterminado), el cuadro de diálogo se mostrará como una nueva ventana del explorador (ventana emergente). Se recomienda para las páginas de autenticación que no se pueden mostrar en un IFrame. Si es true, el cuadro de diálogo se mostrará como una superposición flotante con un IFrame. Es la mejor opción para mejorar el rendimiento y la experiencia del usuario.

displayInIframe?: boolean

Valor de propiedad

boolean

height

Define la altura del cuadro de diálogo como porcentaje de la pantalla actual. El valor predeterminado es 80 %. 250 px como mínimo.

height?: number,

Valor de propiedad

number

Ejemplos

// 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

Determina si el cuadro de diálogo del bloqueador emergente se mostrará al usuario. El valor predeterminado es true.

true: el marco muestra una ventana emergente para desencadenar la navegación y evitar el bloqueador de ventanas emergentes del explorador. false: no se mostrará el cuadro de diálogo y el desarrollador debe controlar las ventanas emergentes (proporcionando un artefacto de la interfaz de usuario para activar el panel de navegación).

promptBeforeOpen?: boolean;

Valor de propiedad

boolean

width

Define el ancho del cuadro de diálogo como porcentaje de la pantalla actual. El valor predeterminado es 80 %. 150 px como mínimo.

width?: number,

Valor de propiedad

number

Ejemplos

// 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);
        });
    }
);