[Office] ダイアログ ボックスでエラーとイベントを処理する

この記事では、ダイアログ ボックスを開くときにエラーをトラップして処理する方法と、ダイアログ ボックス内で発生するエラーについて説明します。

コードでは、2 つのカテゴリのイベントを処理する必要があります。

• ダイアログ ボックスを作成できないために displayDialogAsync の呼び出しによって返されるエラー。
• ダイアログ ボックスのエラー、およびその他のイベント。

displayDialogAsync のエラー

一般的なプラットフォーム エラーとシステム エラーに加えて、4 つのエラーは を呼び出 displayDialogAsyncすことに固有です。

が呼び出されると displayDialogAsync 、 AsyncResult オブジェクトがそのコールバック関数に渡されます。 呼び出しが成功すると、ダイアログ ボックスが開き value 、オブジェクトの AsyncResult プロパティが Dialog オブジェクトになります。 この例については、「 ダイアログ ボックスからホスト ページに情報を送信する」を参照してください。 の displayDialogAsync 呼び出しが失敗すると、ダイアログ ボックスは作成されません。 status オブジェクトの AsyncResult プロパティは に Office.AsyncResultStatus.Failed設定され、 error オブジェクトのプロパティが設定されます。 をテスト status し、エラーが発生したときに応答するコールバックを常に提供する必要があります。 コード番号に関係なくエラー メッセージを報告する例については、次のコードを参照してください。 (この記事で定義されていない関数は showNotification 、エラーを表示またはログに記録します。アドイン内でこの関数を実装する方法の例については、「 Office アドイン ダイアログ API の例」を参照してください)。

let dialog;
Office.context.ui.displayDialogAsync('https://myDomain/myDialog.html',
function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        showNotification(asyncResult.error.code = ": " + asyncResult.error.message);
    } else {
        dialog = asyncResult.value;
        dialog.addEventHandler(Office.EventType.DialogMessageReceived, processMessage);
    }
});

ダイアログ ボックスのエラーとイベント

ダイアログ ボックスの 3 つのエラーとイベントによって、ホスト ページでイベントが発生 DialogEventReceived します。 ホスト ページの内容のリマインダーについては、「ホスト ページ からダイアログ ボックスを開く」を参照してください。

コードで、呼び出し内の DialogEventReceived イベントのハンドラーを displayDialogAsync に割り当てることができます。 次に簡単な例を示します。

let dialog;
Office.context.ui.displayDialogAsync('https://myDomain/myDialog.html',
    function (result) {
        dialog = result.value;
        dialog.addEventHandler(Office.EventType.DialogEventReceived, processDialogEvent);
    }
);

各エラー コードのカスタム エラー メッセージを作成するイベントの DialogEventReceived ハンドラーの例については、次の例を参照してください。

function processDialogEvent(arg) {
    switch (arg.error) {
        case 12002:
            showNotification("The dialog box has been directed to a page that it cannot find or load, or the URL syntax is invalid.");
            break;
        case 12003:
            showNotification("The dialog box has been directed to a URL with the HTTP protocol. HTTPS is required.");            break;
        case 12006:
            showNotification("Dialog closed.");
            break;
        default:
            showNotification("Unknown error in dialog box.");
            break;
    }
}

関連項目

この方法でエラーを処理するサンプル アドインについては、「Office アドイン ダイアログ API の例」を参照してください。