Word アドインの概要

  • [アーティクル]

Wordの機能を拡張するソリューションを作成しますか? たとえば、自動ドキュメント アセンブリが含まれるものなどです。 または、他のデータ ソースからWord ドキュメント内のデータにバインドしてアクセスするソリューションですか? Word JavaScript API と Office JavaScript API を含む Office アドイン プラットフォームを使用して、Windows デスクトップ、Mac、またはクラウドで実行されているクライアントWord拡張できます。

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

注:

アドインを AppSource に 公開 し、Office エクスペリエンス内で利用できるようにする場合は、商用マーケットプレイスの認定ポリシー に準拠していることを確認してください。 たとえば、検証に合格するには、アドインは、定義したメソッドをサポートするすべてのプラットフォーム全体で機能する必要があります (詳細については、セクション 1120.3 と「Office アドイン アプリケーションと可用性」のページを参照してください)。

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

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

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

Word アドインでは、次の操作を実行できます。

  1. Word ドキュメントに要求を送信します。
  2. JavaScript を使用して、段落オブジェクトにアクセスし、段落を更新、削除、または移動します。

たとえば、次のコードは、その段落に新しい文を追加する方法を示しています。

await Word.run(async (context) => {
    const paragraphs = context.document.getSelection().paragraphs;
    paragraphs.load();
    await context.sync();
    paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                       Word.InsertLocation.end);
    await context.sync();
});

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

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

  • Windows でのWord 2016以降
  • Word on the web
  • Mac on Word 2016 以降
  • Word on iPad

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

Word 用 JavaScript API

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

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

現在、Word のすべてのクライアントは共有の Office JavaScript API をサポートし、ほとんどのクライアントは Word JavaScript API をサポートします。 サポートされているクライアントの詳細については、「Office アドインの Office クライアント アプリケーションとプラットフォームの可用性」を参照してください。

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

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

次のいずれかの操作を行う必要がある場合は、共有 Office JavaScript API を使用します。

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

次の手順

最初のWord アドインを作成する準備はできましたか? 「初めてのWord アドインをビルドする」を参照してください。 アドイン マニフェストを使用して、アドインのホスト場所、表示方法、アクセス許可などの情報を定義します。

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

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

関連項目