Share via


OfficeRuntime.DisplayWebDialogOptions interface

Fornece opções de exibição e ações que uma caixa de diálogo pode levar.

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

Propriedades

displayInIFrame

Parâmetro opcional que determina se a caixa de diálogo é exibida como um pop-up (false) ou em um IFrame (true). Essa configuração só é aplicável a funções personalizadas em execução no Excel Online.

height

Parâmetro opcional que define a altura da caixa de diálogo como uma porcentagem da exibição atual. Por exemplo, aceita cadeias de caracteres como: '50%', '50'.

onClose

Retorno de chamada opcional que é executado quando a caixa de diálogo é fechada.

onMessage

Retorno de chamada opcional que é executado quando a caixa de diálogo envia uma mensagem para seu pai.

onRuntimeError

Retorno de chamada opcional que é executado quando a caixa de diálogo envia um erro.

width

Parâmetro opcional que define a largura da caixa de diálogo como um percentual de janela. Por exemplo, aceita cadeias de caracteres como: '50%', '50'.

Detalhes da propriedade

displayInIFrame

Parâmetro opcional que determina se a caixa de diálogo é exibida como um pop-up (false) ou em um IFrame (true). Essa configuração só é aplicável a funções personalizadas em execução no Excel Online.

displayInIFrame?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

height

Parâmetro opcional que define a altura da caixa de diálogo como uma porcentagem da exibição atual. Por exemplo, aceita cadeias de caracteres como: '50%', '50'.

height?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

onClose

Retorno de chamada opcional que é executado quando a caixa de diálogo é fechada.

onClose?: () => void;

Valor da propriedade

() => void

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

onMessage

Retorno de chamada opcional que é executado quando a caixa de diálogo envia uma mensagem para seu pai.

onMessage?: (message: string, dialog?: Dialog) => void;

Valor da propriedade

(message: string, dialog?: OfficeRuntime.Dialog) => void

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

onRuntimeError

Retorno de chamada opcional que é executado quando a caixa de diálogo envia um erro.

onRuntimeError?: (error: Error, dialog?: Dialog) => void;

Valor da propriedade

(error: Error, dialog?: OfficeRuntime.Dialog) => void

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

width

Parâmetro opcional que define a largura da caixa de diálogo como um percentual de janela. Por exemplo, aceita cadeias de caracteres como: '50%', '50'.

width?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]