Word アドインの概要

Word の機能を拡張するソリューション - たとえば、ドキュメントの自動アセンブリや、他のデータ ソースからの Word 文書のデータへのバインドやアクセスを可能にするソリューションの作成をご希望ではありませんか。Word JavaScript API と JavaScript API for Office を含む Office アドイン プラットフォームを使用して、Windows デスクトップ、Mac、またはクラウドで実行する Word クライアントを拡張できます。

Word のアドインは、Office アドイン プラットフォームにある数多くの開発オプションのひとつです。アドイン コマンドを使用して、Word の UI を拡張したり、Word 文書のコンテンツと対話する JavaScript を実行する作業ウィンドウを起動したりすることができます。ブラウザーで実行できるあらゆるコードは、Word アドインで実行できます。Word 文書のコンテンツと対話するアドインは、Word オブジェクトを操作し、オブジェクトの状態を同期する要求を作成します。

> 注:アドインをビルドするとき、アドインを Office ストアに発行する予定であれば、Office ストア検証ポリシーに準拠していることを確認してください。たとえば、検証に合格するには、アドインは、定義したメソッドをサポートするすべてのプラットフォーム全体で機能する必要があります (詳細については、セクション 4.12 と「Office アドインを使用できるホストおよびプラットフォーム」のページを参照してください)。

次の図は、作業ウィンドウで実行される Word アドインの例を示します。

図 1.Word の作業ウィンドウで実行されているアドイン

Word の作業ウィンドウで実行されているアドイン

Word アドイン (1) は、Word 文書 (2) に要求を送信し、JavaScript を使用して段落オブジェクトにアクセスして段落を更新、削除、または移動することができます。たとえば、次のコードは、その段落に新しい文を追加する方法を示しています。

Word.run(function (context) {
    var paragraphs = context.document.getSelection().paragraphs;
    paragraphs.load();
    return context.sync().then(function () {
        paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                       Word.InsertLocation.end);
    }).then(context.sync);
});

ASP.NET、NodeJS、Python などの任意の Web サーバー テクノロジを使用して、Word アドインをホストさせることができます。お気に入りのクライアント側のフレームワーク (Ember、Backbone、Angular、React) を使用するか VanillaJS を引き続き使用してソリューションを開発し、Azure のようなサービスを使用してアプリケーションを認証し、ホストできます。

Word JavaScript API を使用すると、アプリケーションから Word 文書内にあるオブジェクトやメタデータにアクセスできます。これらの API を使用して、以下をターゲットとするアドインを作成できます。

  • Word 2013 for Windows
  • Word 2016 for Windows
  • Word Online
  • Word 2016 for Mac
  • Word for iOS

アドインを 1 回作成すれば、それをプラットフォームの異なるすべてのバージョンの Word で実行できます。詳細については、「Office アドインを使用できるホストおよびプラットフォーム」を参照してください。

Word 用 JavaScript API

2 セットの JavaScript API を使用して、Word 文書のオブジェクトおよびメタデータと対話できます。1 つ目は、Office 2013 で導入された JavaScript API for Office です。これは共有 API です -- 2 つ以上の Office クライアントでホストされているアドインで、多くのオブジェクトを使用することができます。この API は、広範囲にわたってコールバックを使用します。

2 つ目は、Word JavaScript API です。これは、Mac と Windows の Word 2016 を対象とする Word アドインを作成するために使用できる、厳密に型指定されたオブジェクト モデルです。このオブジェクト モデルは promise を使用し、本文コンテンツ コントロールインライン画像、および段落などの Word 固有のオブジェクトへのアクセスを提供します。Word JavaScript API には、IDE 内のコード ヒントを取得できるように、TypeScript の定義と vsdoc ファイルが含まれています。

現在、Word のすべてのクライアントは共有の JavaScript API for Office をサポートし、ほとんどのクライアントは Word JavaScript API をサポートします。サポート対象のクライアントの詳細については、「API リファレンスのドキュメント」を参照してください。

Word JavaScript API のオブジェクト モデルはより簡単に使用できるため、Word JavaScript APから始めることをお勧めします。次のような必要がある場合は、Word JavaScript API を使用します。

  • Word 文書内のオブジェクトにアクセスする。

次のような必要がある場合は、共有の JavaScript API for Office を使用します。

  • Word 2013 を対象とする。
  • アプリケーションの初期アクションを実行する。
  • サポートされている要件セットを確認する。
  • メタデータ、設定、およびドキュメントの環境情報にアクセスする。
  • ドキュメント内のセクションにバインドし、イベントをキャプチャする。
  • カスタム XML パーツを使用する。
  • ダイアログ ボックスを開く。

次の手順

最初の Word アドインを作成する準備はできましたか?「最初の Word アドインをビルドする」を参照してください。また、対話式の「作業の開始エクスペリエンス」も使用できます。アドインのマニフェストを使用して、アドインがホストされている場所や表示方法の説明と、アクセス許可およびその他の情報の定義を行います。

ユーザーにとって魅力的なエクスペリエンスを提供する世界クラスの Word アドインを設計する方法の詳細については、「設計のガイドライン」と「ベスト プラクティス」を参照してください。

アドインを作成したら、ネットワーク共有、アプリ カタログ、または Office ストアに発行できます。

今後の Word アドイン

新しい Word アドイン用の API の設計と開発にあたり、Open API の仕様 ページでこれらに対するフィードバックの提供が可能になります。Word JavaScript API 用のパイプラインの新機能をご確認いただき、設計の仕様に関する情報をお寄せください。

また、変更ログ ページでも Word JavaScript API の新機能を確認できます。

その他のリソース