OfficeRuntime.DisplayWebDialogOptions interface

パッケージ:

office-runtime

ダイアログ ボックスで実行できる表示オプションとアクションを提供します。

注釈

[ API セット: 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 セット: CustomFunctionsRuntime 1.1 ]

height

ダイアログ ボックスの高さを現在の表示のパーセンテージとして定義する省略可能なパラメーター。 たとえば、"50%"、"50" などの文字列を受け入れます。

height?: string;

プロパティ値

string

注釈

[ API セット: CustomFunctionsRuntime 1.1 ]

onClose

ダイアログ ボックスが閉じられたときに実行される省略可能なコールバック。

onClose?: () => void;

プロパティ値

() => void

注釈

[ API セット: CustomFunctionsRuntime 1.1 ]

onMessage

ダイアログ ボックスがメッセージを親に送信するときに実行される省略可能なコールバック。

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

プロパティ値

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

注釈

[ API セット: CustomFunctionsRuntime 1.1 ]

onRuntimeError

ダイアログ ボックスがエラーを送信するときに実行される省略可能なコールバック。

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

プロパティ値

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

注釈

[ API セット: CustomFunctionsRuntime 1.1 ]

width

ダイアログの幅をウィンドウの割合として定義する省略可能なパラメーター。 たとえば、"50%"、"50" などの文字列を受け入れます。

width?: string;

プロパティ値

string

注釈

[ API セット: CustomFunctionsRuntime 1.1 ]