Office.DialogOptions interface

Pacote:

office

Fornece opções de como uma caixa de diálogo é exibida.

Propriedades

asyncContext	Um item definido pelo usuário de qualquer tipo retornado, inalterado, na propriedade asyncContext do objeto AsyncResult que é passado para um retorno de chamada.
displayInIframe	Determina se a caixa de diálogo deve ser exibida em um IFrame. Essa configuração só é aplicável em Office na Web e é ignorada por outras plataformas. Se false (padrão), a caixa de diálogo será exibida como uma nova janela do navegador (pop-up). Recomendado para páginas de autenticação que não podem ser exibidas em um IFrame. Se for true, a caixa de diálogo será exibida como uma sobreposição flutuante com um IFrame. Isso é ideal para o desempenho e a experiência do usuário.
height	Define a altura da caixa de diálogo como um percentual da exibição atual. O padrão é 80%. Mínimo de 250 px.
promptBeforeOpen	Determina se a caixa de diálogo do bloqueador pop-up será mostrada ao usuário. O padrão é true. true - A estrutura exibe um pop-up para acionar o painel de navegação e evitar bloqueadores de pop-up do navegador. false - A caixa de diálogo não será exibida e o desenvolvedor deverá lidar com pop-ups (fornecendo um artefato da interface de usuário para acionar a navegação).
width	Define a largura da caixa de diálogo como um percentual da exibição atual. O padrão é 80%. Mínimo de 150 px.

Detalhes da propriedade

asyncContext

Um item definido pelo usuário de qualquer tipo retornado, inalterado, na propriedade asyncContext do objeto AsyncResult que é passado para um retorno de chamada.

asyncContext?: any

Valor da propriedade

any

displayInIframe

Determina se a caixa de diálogo deve ser exibida em um IFrame. Essa configuração só é aplicável em Office na Web e é ignorada por outras plataformas. Se false (padrão), a caixa de diálogo será exibida como uma nova janela do navegador (pop-up). Recomendado para páginas de autenticação que não podem ser exibidas em um IFrame. Se for true, a caixa de diálogo será exibida como uma sobreposição flutuante com um IFrame. Isso é ideal para o desempenho e a experiência do usuário.

displayInIframe?: boolean

Valor da propriedade

boolean

height

Define a altura da caixa de diálogo como um percentual da exibição atual. O padrão é 80%. Mínimo de 250 px.

height?: number,

Valor da propriedade

number

Exemplos

// 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 se a caixa de diálogo do bloqueador pop-up será mostrada ao usuário. O padrão é true.

true - A estrutura exibe um pop-up para acionar o painel de navegação e evitar bloqueadores de pop-up do navegador. false - A caixa de diálogo não será exibida e o desenvolvedor deverá lidar com pop-ups (fornecendo um artefato da interface de usuário para acionar a navegação).

promptBeforeOpen?: boolean;

Valor da propriedade

boolean

width

Define a largura da caixa de diálogo como um percentual da exibição atual. O padrão é 80%. Mínimo de 150 px.

width?: number,

Valor da propriedade

number

Exemplos

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