OfficeRuntime.DisplayWebDialogOptions interface

包:

office-runtime

提供对话框可能采取的显示选项和操作。

注解

[ API set： CustomFunctionsRuntime 1.1 ]

属性

displayInIFrame	可选参数，用于确定对话框是显示为弹出 (false) ，还是在 IFrame (true) 显示。 此设置仅适用于在 Excel Online 上运行的自定义函数。
height	可选参数，用于将对话框的高度定义为当前显示器的百分比。 例如，接受字符串，例如：“50%”、“50”。
onClose	关闭对话框时运行的可选回调。
onMessage	当对话框向其父级发送消息时运行的可选回调。
onRuntimeError	对话框发送错误时运行的可选回调。
width	将对话框的宽度定义为窗口百分比的可选参数。 例如，接受字符串，例如：“50%”、“50”。

属性详细信息

displayInIFrame

可选参数，用于确定对话框是显示为弹出 (false) ，还是在 IFrame (true) 显示。 此设置仅适用于在 Excel Online 上运行的自定义函数。

displayInIFrame?: boolean;

属性值

boolean

注解

[ API set： CustomFunctionsRuntime 1.1 ]

height

可选参数，用于将对话框的高度定义为当前显示器的百分比。 例如，接受字符串，例如：“50%”、“50”。

height?: string;

属性值

string

注解

[ API set： CustomFunctionsRuntime 1.1 ]

onClose

关闭对话框时运行的可选回调。

onClose?: () => void;

属性值

() => void

注解

[ API set： CustomFunctionsRuntime 1.1 ]

onMessage

当对话框向其父级发送消息时运行的可选回调。

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

属性值

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

注解

[ API set： CustomFunctionsRuntime 1.1 ]

onRuntimeError

对话框发送错误时运行的可选回调。

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

属性值

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

注解

[ API set： CustomFunctionsRuntime 1.1 ]

width

将对话框的宽度定义为窗口百分比的可选参数。 例如，接受字符串，例如：“50%”、“50”。

width?: string;

属性值

string

注解

[ API set： CustomFunctionsRuntime 1.1 ]