OfficeRuntime.DisplayWebDialogOptions interface
Provides display options and actions a dialog box may take.
Properties
| display |
Optional parameter that determines whether the dialog box displays as a popup (false) or within an IFrame (true). This setting is only applicable to custom functions running on Excel Online. |
| height | Optional parameter that defines the height of the dialog box as a percentage of the current display. For example, accepts strings such as: '50%', '50'. |
| on |
Optional callback that runs when the dialog box is closed. |
| on |
Optional callback that runs when the dialog box sends a message to its parent. |
| on |
Optional callback that runs when the dialog box sends an error. |
| width | Optional parameter that defines the width of dialog as a percentage of window. For example, accepts strings such as: '50%', '50'. |
Property Details
displayInIFrame
Optional parameter that determines whether the dialog box displays as a popup (false) or within an IFrame (true). This setting is only applicable to custom functions running on Excel Online.
displayInIFrame?: boolean;Property Value
boolean
Remarks
height
Optional parameter that defines the height of the dialog box as a percentage of the current display. For example, accepts strings such as: '50%', '50'.
height?: string;Property Value
string
Remarks
onClose
Optional callback that runs when the dialog box is closed.
onClose?: () => void;Property Value
() => void
Remarks
onMessage
Optional callback that runs when the dialog box sends a message to its parent.
onMessage?: (message: string, dialog?: Dialog) => void;Property Value
(message: string, dialog?: OfficeRuntime.Dialog) => void
Remarks
onRuntimeError
Optional callback that runs when the dialog box sends an error.
onRuntimeError?: (error: Error, dialog?: Dialog) => void;Property Value
(error: Error, dialog?: OfficeRuntime.Dialog) => void
Remarks
width
Optional parameter that defines the width of dialog as a percentage of window. For example, accepts strings such as: '50%', '50'.
width?: string;Property Value
string