OfficeRuntime.DisplayWebDialogOptions interface

Pacote:

office-runtime

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

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

Propriedades

displayInIFrame	Parâmetro opcional que determina se a caixa de diálogo é apresentada como um pop-up (falso) ou num IFrame (verdadeiro). Esta definiçã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 percentagem do ecrã atual. Por exemplo, aceita cadeias como: "50%", "50".
onClose	Chamada de retorno opcional que é executada quando a caixa de diálogo é fechada.
onMessage	Chamada de retorno opcional que é executada quando a caixa de diálogo envia uma mensagem para o respetivo elemento principal.
onRuntimeError	Chamada de retorno opcional que é executada quando a caixa de diálogo envia um erro.
width	Parâmetro opcional que define a largura da caixa de diálogo como uma percentagem de janela. Por exemplo, aceita cadeias como: "50%", "50".

Detalhes da propriedade

displayInIFrame

Parâmetro opcional que determina se a caixa de diálogo é apresentada como um pop-up (falso) ou num IFrame (verdadeiro). Esta definiçã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 percentagem do ecrã atual. Por exemplo, aceita cadeias como: "50%", "50".

height?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

onClose

Chamada de retorno opcional que é executada quando a caixa de diálogo é fechada.

onClose?: () => void;

Valor da propriedade

() => void

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

onMessage

Chamada de retorno opcional que é executada quando a caixa de diálogo envia uma mensagem para o respetivo elemento principal.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]

onRuntimeError

Chamada de retorno opcional que é executada 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 uma percentagem de janela. Por exemplo, aceita cadeias como: "50%", "50".

width?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: CustomFunctionsRuntime 1.1 ]