OfficeRuntime.DisplayWebDialogOptions interface
ダイアログ ボックスの表示オプションとアクションを提供します。
注釈
API セット: CustomFunctionsRuntime 1.1
使用元
例
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);
プロパティ
| display |
ダイアログ ボックスをポップアップ (false) として表示するか、IFrame 内 (true) として表示するかを決定するオプションのパラメーター。 この設定は、Excel Online で実行されているカスタム関数にのみ適用されます。 |
| height | ダイアログ ボックスの高さを現在の表示に対する割合で定義するオプションのパラメーター。 たとえば、 '50%'、'50' などの文字列を受け付けます。 |
| on |
ダイアログ ボックスが閉じられたときに実行される省略可能なコールバック。 |
| on |
ダイアログ ボックスが親にメッセージを送信するときに実行される省略可能なコールバック。 |
| on |
ダイアログ ボックスでエラーが送信されたときに実行される省略可能なコールバック。 |
| width | ダイアログの幅をウィンドウに対する割合として定義する省略可能なパラメーター。 たとえば、 '50%'、'50' などの文字列を受け付けます。 |
プロパティの詳細
displayInIFrame
ダイアログ ボックスをポップアップ (false) として表示するか、IFrame 内 (true) として表示するかを決定するオプションのパラメーター。 この設定は、Excel Online で実行されているカスタム関数にのみ適用されます。
displayInIFrame?: boolean;プロパティ値
boolean
注釈
height
ダイアログ ボックスの高さを現在の表示に対する割合で定義するオプションのパラメーター。 たとえば、 '50%'、'50' などの文字列を受け付けます。
height?: string;プロパティ値
string
注釈
onClose
ダイアログ ボックスが閉じられたときに実行される省略可能なコールバック。
onClose?: () => void;プロパティ値
() => void
注釈
onMessage
ダイアログ ボックスが親にメッセージを送信するときに実行される省略可能なコールバック。
onMessage?: (message: string, dialog?: Dialog) => void;プロパティ値
(message: string, dialog?: OfficeRuntime.Dialog) => void
注釈
onRuntimeError
ダイアログ ボックスでエラーが送信されたときに実行される省略可能なコールバック。
onRuntimeError?: (error: Error, dialog?: Dialog) => void;プロパティ値
(error: Error, dialog?: OfficeRuntime.Dialog) => void
注釈
width
ダイアログの幅をウィンドウに対する割合として定義する省略可能なパラメーター。 たとえば、 '50%'、'50' などの文字列を受け付けます。
width?: string;プロパティ値
string