Excel、Word、PowerPoint のアドイン コマンドAdd-in commands for Excel, Word, and PowerPoint

アドイン コマンドは、Office UI を拡張し、アドインでアクションを開始する UI 要素です。アドイン コマンドを使用すると、リボン上のボタンやアイテムをコンテキスト メニューに追加できます。ユーザーがアドイン コマンドを選択すると、JavaScript コードを実行したり、アドインのページを作業ウィンドウに表示するなどのアクションが開始されます。アドイン コマンドは、ユーザーがアドインを検索して使用ために役立ちます。これにより、アドインの導入と再利用を促進し、顧客維持率を向上させることができます。Add-in commands are UI elements that extend the Office UI and start actions in your add-in. You can use add-in commands to add a button on the ribbon or an item to a context menu. When users select an add-in command, they initiate actions such as running JavaScript code, or showing a page of the add-in in a task pane. Add-in commands help users find and use your add-in, which can help increase your add-in's adoption and reuse, and improve customer retention.

機能の概要については、ビデオ「Office リボンのアドイン コマンド」を参照してください。For an overview of the feature, see the video Add-in Commands in the Office Ribbon.

注意

SharePoint カタログは、アドイン コマンドをサポートしません。集中展開または AppSource でアドイン コマンドを展開するか、またはサイドロードを使ってテストのためのアドイン コマンドを展開できます。SharePoint catalogs do not support add-in commands. You can deploy add-in commands via Centralized Deployment or AppSource, or use sideloading to deploy your add-in command for testing.

図 1. Excel デスクトップで実行するコマンドを含むアドインFigure 1. Add-in with commands running in Excel Desktop

Excel のアドイン コマンドのスクリーンショット

図 2. Excel Online で実行するコマンドを含むアドインFigure 2. Add-in with commands running in Excel Online

Excel Online のアドイン コマンドのスクリーンショット

コマンドの機能Command capabilities

現在は、次のコマンド機能がサポートされています。The following command capabilities are currently supported.

注意

現在、コンテンツ アドインは、アドイン コマンドをサポートしていません。Content add-ins do not currently support add-in commands.

拡張点Extension points

  • リボン タブ: 組み込みのタブを拡張するか、新しいカスタム タブを作成します。Ribbon tabs - Extend built-in tabs or create a new custom tab.
  • コンテキスト メニュー: 選択されたコンテキスト メニューを拡張します。Context menus - Extend selected context menus.

コントロールの種類Control types

  • 単純なボタン: 特定のアクションをトリガーします。Simple buttons - trigger specific actions.
  • メニュー: アクションをトリガーするボタン付きの単純なメニューのドロップダウン。Menus - simple menu dropdown with buttons that trigger actions.

アクションActions

  • ShowTaskpane: カスタムの HTML ページをロードする 1 つまたは複数のウィンドウを表示します。ShowTaskpane - Displays one or multiple panes that load custom HTML pages inside them.
  • ExecuteFunction: 非表示の HTML ページをロードして、JavaScript 関数を実行します。関数内で UI を表示するには (エラー、進行状況、追加入力など)、displayDialog API を使用できます。ExecuteFunction - Loads an invisible HTML page and then execute a JavaScript function within it. To show UI within your function (such as errors, progress, or additional input) you can use the displayDialog API.

サポートされるプラットフォームSupported platforms

現在、アドイン コマンドは次のプラットフォームでサポートされています。Add-in commands are currently supported on the following platforms:

  • Windows デスクトップ 2016 版 Office (ビルド 16.0.6769 以降)Office for Windows Desktop 2016 (build 16.0.6769+)
  • Office for Mac (ビルド 15.33 以降)Office for Mac (build 15.33+)
  • Office OnlineOffice Online

その他のプラットフォームが近日中に公開されます。More platforms are coming soon.

ベスト プラクティスBest practices

アドイン コマンドを開発するときは、次のベスト プラクティスを適用します。Apply the following best practices when you develop add-in commands:

  • ユーザーに対して、特定のアクションとともにアクションの結果を明確かつ具体的に表すコマンドを使用します。複数のアクションを 1 つのボタンにまとめないでください。Use commands to represent a specific action with a clear and specific outcome for users. Do not combine multiple actions in a single button.
  • アドイン内の一般的なタスクをより効率的に実行できるように、アクションは細分化して提供します。1 つのアクションを完了するまでのステップ数は最小限に抑えます。Provide granular actions that make common tasks within your add-in more efficient to perform. Minimize the number of steps an action takes to complete.
  • Office リボンにコマンドを配置するために。For the placement of your commands in the Office ribbon:

    • 提供する機能が適応する場合は既存のタブ (挿入、レビューなど) にコマンドを配置します。たとえば、アドインを使用することでユーザーがメディアを挿入できる場合は、[挿入] タブにグループを追加します。Office のすべてのバージョンで、すべてのタブが使用可能なわけではない点に注意してください。詳細については、「Office アドイン XML マニフェスト」を参照してください。Place commands on an existing tab (Insert, Review, and so on) if the functionality provided fits there. For example, if your add-in enables users to insert media, add a group to the Insert tab. Note that not all tabs are available across all Office versions. For more information, see Office Add-ins XML manifest.
    • 別のタブに機能が適応せず、トップ レベル コマンドが 6 個未満の場合は、[ホーム] タブにコマンドを配置します。Office デスクトップと Office Online など、Office の複数のバージョン間でアドインを操作する必要があり、タブがどのバージョンでも利用できるわけではない場合 (たとえば、[デザイン] タブは Office Online にはありません) は、[ホーム] タブにコマンドを追加できます。Place commands on the Home tab if the functionality doesn't fit on another tab, and you have fewer than six top-level commands. You can also add commands to the Home tab if your add-in needs to work across Office versions (such as Office Desktop and Office Online) and a tab is not available in all versions (for example, the Design tab doesn't exist in Office Online).
    • 6 個以上のトップ レベル コマンドがある場合は、コマンドをカスタム タブに配置します。Place commands on a custom tab if you have more than six top-level commands.
    • グループに、アドインの名前と一致する名前を指定します。グループが複数ある場合は、そのグループのコマンドが提供する機能に基づいた名前を各グループに付けます。Name your group to match the name of your add-in. If you have multiple groups, name each group based on the functionality that the commands in that group provide.
    • アドインの使用スペースを増やす余分なボタンを追加しないでください。Do not add superfluous buttons to increase the real estate of your add-in.

      注意

      占有領域が大きすぎるアドインは AppSource 検証を通過しない場合があります。Add-ins that take up too much space might not pass AppSource validation.

  • すべてのアイコンについては、アイコン デザインのガイドラインに従ってください。For all icons, follow the icon design guidelines.

  • コマンドをサポートしていないホストでも動作するアドインのバージョンを提供します。1 つのアドインのマニフェストは、コマンド対応 (コマンドを使用) ホストとコマンド非対応 (作業ウィンドウとして) ホストの両方で動作します。Provide a version of your add-in that also works on hosts that do not support commands. A single add-in manifest can work in both command-aware (with commands) and non-command-aware (as a taskpane) hosts.

    図 3. Office 2013 の作業ウィンドウのアドインと、Office 2016 のアドイン コマンドを使用する同じアドインFigure 3. Task pane add-in in Office 2013 and the same add-in using add-in commands in Office 2016

    Office 2013 の作業ウィンドウのアドインと、Office 2016 のアドイン コマンドを使用する同じアドインを示すスクリーンショット

次の手順Next steps

アドイン コマンドの使用を開始するために最適な方法は、GitHub の「Office-Add-in-Commands-Samples」を参照することです。The best way to get started using add-in commands is to take a look at the Office Add-in commands samples on GitHub.

マニフェストでのアドイン コマンドの指定の詳細については、「マニフェストでアドイン コマンドを作成する」と「VersionOverrides 要素」のリファレンス資料をご覧ください。For more information about specifying add-in commands in your manifest, see Create add-in commands in your manifest and the VersionOverrides reference content.