エラー処理

Excel JavaScript API を使用してアドインを作成する場合は、実行時エラーを考慮するために、エラー処理ロジックを含めます。 これは、API の非同期性のために重要になります。

:sync() メソッドと Excel JavaScript API の非同期性の詳細については、「Excel JavaScript API の中心概念」を参照してください。

ベスト プラクティス

このドキュメントのコード サンプルでは、Excel.run へのすべての呼び出しに、Excel.run 内で発生したエラーを検出するための catch ステートメントが付いていることがわかります。 Excel JavaScript Api を使用してアドインを構築するときには、同じパターンを使用することをお勧めします。

Excel.run(function (context) { 

  // Excel JavaScript API calls here

  // Await the completion of context.sync() before continuing.
  return context.sync()
    .then(function () {
      console.log("Finished!");
    })
}).catch(errorHandlerFunction);     

API エラー

Excel JavaScript API 要求が正常に実行されない場合、API は次のプロパティを含むエラー オブジェクトを返します。

  • code:エラー メッセージの code プロパティには、OfficeExtension.ErrorCodes または Excel.ErrorCodes リストの一部である文字列が含まれます。 たとえば、エラー コード "InvalidReference" は、参照が指定された操作に対して有効でないことを示します。 エラー コードはローカライズされません。

  • message:エラー メッセージの message プロパティには、ローカライズされた文字列のエラーの概要が含まれます。 このエラー メッセージは、エンドユーザーが使用するためのものではありません。エラー コードと適切なビジネス ロジックを使用して、アドインがエンドユーザーに表示するエラー メッセージを判断する必要があります。

  • debugInfo:存在する場合、エラー メッセージの debugInfo プロパティは、エラーの根本原因を理解するために使用できる追加情報を提供します。

:console.log() を使用してエラー メッセージをコンソールに出力すると、それらのメッセージはサーバー上でのみ表示されます。 これらのエラー メッセージが、アドインの作業ウィンドウやホスト アプリケーション内のいずれかの場所で、エンドユーザーに対して表示されることはありません。

その他のリソース