OfficeRuntime.DisplayWebDialogOptions interface
Fornece opções de exibição e ações que uma caixa de diálogo pode executar.
Comentários
Conjunto de APIs: CustomFunctionsRuntime 1.1
Usada por
Exemplos
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);
Propriedades
| display |
Parâmetro opcional que determina se a caixa de diálogo será exibida como um pop-up (falso) ou dentro de um IFrame (verdadeiro). 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'. |
| on |
Retorno de chamada opcional que é executado quando a caixa de diálogo é fechada. |
| on |
Retorno de chamada opcional que é executado quando a caixa de diálogo envia uma mensagem ao pai. |
| on |
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 uma porcentagem da 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 será exibida como um pop-up (falso) ou dentro de um IFrame (verdadeiro). Essa configuração só é aplicável a funções personalizadas em execução no Excel Online.
displayInIFrame?: boolean;Valor da propriedade
boolean
Comentários
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
onClose
Retorno de chamada opcional que é executado quando a caixa de diálogo é fechada.
onClose?: () => void;Valor da propriedade
() => void
Comentários
onMessage
Retorno de chamada opcional que é executado quando a caixa de diálogo envia uma mensagem ao pai.
onMessage?: (message: string, dialog?: Dialog) => void;Valor da propriedade
(message: string, dialog?: OfficeRuntime.Dialog) => void
Comentários
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
width
Parâmetro opcional que define a largura da caixa de diálogo como uma porcentagem da janela. Por exemplo, aceita cadeias de caracteres como: '50%', '50'.
width?: string;Valor da propriedade
string