次の方法で共有


非共有ランタイムでのカスタム関数のデバッグ

この記事では、共有ランタイムを使用しないカスタム関数についてのみデバッグについて説明します。 共有ランタイム シナリオについては、「 Office アドインのデバッグの概要」を参照してください。

重要

Excel カスタム関数は、次のプラットフォームで使用できます。

  • Office on the web
  • Windows での Office
    • Microsoft 365 サブスクリプション
    • retail 永久 Office 2016 以降
    • ボリューム ライセンスの永続的/LTSC Office 2021 以降
  • Office on Mac

Excel カスタム関数は現在、次ではサポートされていません。

  • Office on iPad
  • ボリューム ライセンスの永続的なバージョンのOffice 2021以前の Windows

注:

Microsoft 365 の統合マニフェストでは、現在、カスタム関数プロジェクトはサポートされていません。 カスタム関数プロジェクトにはアドインのみのマニフェストを使用する必要があります。 詳細については、「 Office アドイン マニフェスト」を参照してください。

注:

共有ランタイムを使用しない特定の理由がない限り、 共有ランタイムでカスタム関数を使用することをお勧めします。 ランタイムの詳細については、「 Office アドインのランタイム」を参照してください。

ヒント

この記事で説明するデバッグ手法は、Yeoman ジェネレーターの マニフェストのみのオプションを含む Office アドイン プロジェクトで 作成されたプロジェクトでは機能しません。 この記事の後半で参照されるスクリプトは、そのオプションと共にインストールされません。 このオプションで作成されたアドインをデバッグするには、必要に応じて、次のいずれかの記事の手順を参照してください。

共有ランタイムを使用しないアドインのカスタム関数をデバッグするプロセスは、ターゲット プラットフォーム (Windows、Mac、または Web) と、Visual Studio Code または別の IDE のどちらを使用しているかによって異なります。 デバッグ シナリオに関連するこの記事のセクションにアクセスするには、次の表のリンクを使用します。 この表では、"CF-NSR" は、非共有ランタイムのカスタム関数を指します。

ターゲット プラットフォーム Visual Studio Code その他の IDE
Excel on the web VS Code とブラウザー開発ツールを使用する コマンド ライン ツールを使用する
Excel on Windows VS Code とブラウザー開発ツールを使用する VS Code 以外の Windows 上の Excel で実行されている CF-NSR のデバッグはサポートされていません。 Excel on the webに対してデバッグします。
Excel on Mac Excel on Mac で実行されている CF-NSR の VS Code デバッグはサポートされていません。 Excel on the webに対してデバッグします。 コマンド ライン ツールを使用する

ブラウザー開発者ツールを使用して、Excel on the webのカスタム関数をデバッグする

ブラウザー開発者ツールを使用して、Excel on the webで共有ランタイムを使用しないカスタム関数をデバッグします。 次の手順は、Windows と macOS で動作します。

Visual Studio Code からアドインを実行する

  1. Visual Studio Code (VS Code) でカスタム関数のルート プロジェクト フォルダーを開きます。
  2. [ターミナル] >[タスクの実行] を選択し、[ウォッチ] を実行します。 これにより、ファイルの変更が監視され、再構築されます。
  3. [ ターミナル>タスクの実行 ] を選択し、 Dev Server を実行します

アドインのサイドロード

  1. Office on the webを開きます。

  2. 新しい Excel ブックを開きます。

  3. [ ホーム>アドイン] を選択し、[ その他の設定] を選択します。

  4. [ Office アドイン ] ダイアログで、[ マイ アドインのアップロード] を選択します。

  5. アドイン マニフェスト ファイルを参照して、[アップロード] を選択します。

    [参照]、[アップロード]、[キャンセル] のボタンがある [アドインのアップロード] ダイアログ。

注:

ドキュメントにサイドロードすると、ドキュメントを開くたびにサイドロードされたままになります。

デバッグの開始

  1. ブラウザーの開発者ツールを開きます。 Chrome とほとんどのブラウザーで、F12 キーを押して開発者ツールを開きます。
  2. 開発者ツールで、 Cmd+P または Ctrl+P (functions.js または functions.ts) を使用してソース コード スクリプト ファイルを開きます。
  3. カスタム関数のソース コードにブレークポイントを設定します

変更を加える必要がある場合は、VS Code でコードを編集し、作業内容を保存してから、ブック ページを更新して更新プログラムを適用します。

コマンド ライン ツールを使用してデバッグする

VS Code を使用しない場合は、Bash や PowerShell などのツールを使用して、コマンド ラインからアドインを実行します。 Excel on the webでコードをデバッグするには、ブラウザーの開発者ツールを使用します。

  1. コマンド ラインから npm run watch を実行して、コードが変更されたときに監視および再構築します。

  2. 2 つ目のコマンド ライン ウィンドウを開きます (最初のコマンド ライン ウィンドウは、ウォッチの実行中はビジー状態です)。

  3. デスクトップ バージョンの Excel でアドインを開始し、プロジェクトの package.json ファイルの [スクリプト] セクションに "start:desktop" スクリプトが含まれている場合は、 npm run start:desktop実行します。それ以外の場合は、 npm run startを実行します。

    または、アドインを起動する場合は、次のコマンドExcel on the web実行します。

    npm run start -- web --document {url} (ここで、 {url} は OneDrive または SharePoint 上の Excel ファイルの URL です)

    注:

    Mac で開発している場合は、 {url} を単一引用符で囲みます。 Windows ではこれを行 わないでください

    ドキュメントにアドインがサイドロードされない場合は、「アドインを サイドロードする」の手順に従います。 次に、次のセクションに進んでデバッグを開始します。

  4. ブラウザーの開発者ツールを開きます。 Chrome とほとんどのブラウザーで、F12 キーを押して開発者ツールを開きます。

  5. 開発者ツールで、ソース コード スクリプト ファイル (functions.js または functions.ts) を開きます。 カスタム関数コードは、ファイルの末尾の近くに配置される場合があります。

  6. カスタム関数のソース コードで、コード行を選択してブレークポイントを適用します。

コードを変更する必要がある場合は、VS Code で編集を行い、変更を保存できます。 ブラウザーを更新して、読み込まれた変更を確認します。

アドインをビルドして実行するためのコマンド

使用可能なビルド タスク:

  • npm run watch: 開発用にビルドされ、ソース ファイルの保存時に自動的に再構築されます。
  • npm run build-dev: 開発用のビルドを 1 回行う
  • npm run build: 運用環境用のビルド
  • npm run dev-server: 開発に使用される Web サーバーを実行します。

デバッグを開始するには、次のタスクを使用します。

  • npm run start:desktop: デスクトップで Excel を起動し、アドインをサイドロードします。 プロジェクトの package.json ファイルの "スクリプト" セクションに "start:desktop" スクリプトが存在しない場合は、代わりに npm run start を実行します。

  • npm run start -- web --document {url}(ここで、{url}は OneDrive または SharePoint 上の Excel ファイルの URL です):Excel on the webを開始し、アドインをサイドロードします。

    注:

    Mac で開発している場合は、 {url} を単一引用符で囲みます。 Windows ではこれを行 わないでください

  • npm run stop: Excel とデバッグを停止します。

次の手順

共有ランタイムを使用しないカスタム関数の認証について説明します。

関連項目