Word アドインの概要Word add-ins overview

Word の機能を拡張するソリューション (たとえば、ドキュメントの自動アセンブリや、他のデータ ソースからの Word 文書のデータへのバインドやアクセスを可能にするソリューション) を作成したい場合は、Word JavaScript API と JavaScript API for Office を含む Office アドイン プラットフォームを使用して、Windows デスクトップ、Mac、またはクラウドで実行する Word クライアントを拡張できます。Do you want to create a solution that extends the functionality of Word? For example, one that involves automated document assembly? Or a solution that binds to and accesses data in a Word document from other data sources? You can use the Office Add-ins platform, which includes the Word JavaScript API and the JavaScript API for Office, to extend Word clients running on a Windows desktop, on a Mac, or in the cloud.

Word のアドインは、Office アドイン プラットフォームにある数多くの開発オプションのひとつです。アドイン コマンドを使用して、Word の UI を拡張したり、Word 文書のコンテンツと対話する JavaScript を実行する作業ウィンドウを起動したりすることができます。ブラウザーで実行できるあらゆるコードは、Word アドインで実行できます。Word 文書のコンテンツと対話するアドインは、Word オブジェクトを操作し、オブジェクトの状態を同期する要求を作成します。Word add-ins are one of the many development options that you have on the Office Add-ins platform. You can use add-in commands to extend the Word UI and launch task panes that run JavaScript that interacts with the content in a Word document. Any code that you can run in a browser can run in a Word add-in. Add-ins that interact with content in a Word document create requests to act on Word objects and synchronize object state.

注意

アドインをビルドするとき、アドインを AppSource に発行する予定であれば、AppSource 検証ポリシーに準拠していることを確認してください。たとえば、検証に合格するには、アドインは、定義したメソッドをサポートするすべてのプラットフォーム全体で機能する必要があります (詳細については、セクション 4.12 と「Office アドインを使用できるホストおよびプラットフォーム」のページを参照してください)。When you build your add-in, if you plan to publish your add-in to AppSource, make sure that you conform to the AppSource validation policies. For example, to pass validation, your add-in must work across all platforms that support the methods that you define (for more information, see section 4.12 and the Office Add-in host and availability page).

次の図は、作業ウィンドウで実行される Word アドインの例を示します。The following figure shows an example of a Word add-in that runs in a task pane.

図 1. Word の作業ウィンドウで実行されているアドインFigure 1. Add-in running in a task pane in Word

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

Word アドイン (1) は、Word 文書 (2) に要求を送信し、JavaScript を使用して段落オブジェクトにアクセスして段落を更新、削除、または移動することができます。たとえば、次のコードは、その段落に新しい文を追加する方法を示しています。The Word add-in (1) can send requests to the Word document (2) and can use JavaScript to access the paragraph object and update, delete, or move the paragraph. For example, the following code shows how to append a new sentence to that paragraph.

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 のようなサービスを使用してアプリケーションを認証し、ホストできます。You can use any web server technology to host your Word add-in, such as ASP.NET, NodeJS, or Python. Use your favorite client-side framework -- Ember, Backbone, Angular, React -- or stick with VanillaJS to develop your solution, and you can use services like Azure to authenticate and host your application.

Word JavaScript API を使用すると、アプリケーションから Word 文書内にあるオブジェクトやメタデータにアクセスできます。これらの API を使用して、以下をターゲットとするアドインを作成できます。The Word JavaScript APIs give your application access to the objects and metadata found in a Word document. You can use these APIs to create add-ins that target:

  • Windows Word 2013 以降Word 2013 or later for Windows
  • Word OnlineWord Online
  • Word for Mac 2016 以降Word 2016 or later for Mac
  • Word for iOSWord for iOS

アドインを 1 回作成すれば、それをプラットフォームの異なるすべてのバージョンの Word で実行できます。詳細については、「Office アドインを使用できるホストおよびプラットフォーム」を参照してください。Write your add-in once, and it will run in all versions of Word across multiple platforms. For details, see Office Add-in host and platform availability.

Word 用 JavaScript APIJavaScript APIs for Word

2 セットの JavaScript API を使用して、Word 文書のオブジェクトおよびメタデータと対話できます。1 つ目は、Office 2013 で導入された JavaScript API for Office です。これは共有 API です -- 2 つ以上の Office クライアントでホストされているアドインで、多くのオブジェクトを使用することができます。この API は、広範囲にわたってコールバックを使用します。You can use two sets of JavaScript APIs to interact with the objects and metadata in a Word document. The first is the JavaScript API for Office, which was introduced in Office 2013. This is a shared API -- many of the objects can be used in add-ins hosted by two or more Office clients. This API uses callbacks extensively.

2 つ目は、Word JavaScript API です。これは、Mac と Windows の Word 2016 を対象とする Word アドインを作成するために使用できる、厳密に型指定されたオブジェクト モデルです。このオブジェクト モデルは promise を使用し、本文コンテンツ コントロールインライン画像、および段落などの Word 固有のオブジェクトへのアクセスを提供します。Word JavaScript API には、IDE 内のコード ヒントを取得できるように、TypeScript の定義と vsdoc ファイルが含まれています。The second is the Word JavaScript API. This is a strongly-typed object model that you can use to create Word add-ins that target Word 2016 for Mac and Windows. This object model uses promises, and provides access to Word-specific objects like body, content controls, inline pictures, and paragraphs. The Word JavaScript API includes TypeScript definitions and vsdoc files so that you can get code hints in your IDE.

現在、Word のすべてのクライアントは共有の JavaScript API for Office をサポートし、ほとんどのクライアントは Word JavaScript API をサポートします。サポート対象のクライアントの詳細については、「API リファレンスのドキュメント」を参照してください。Currently, all Word clients support the shared JavaScript API for Office, and most clients support the Word JavaScript API. For details about supported clients, see the API reference documentation.

Word JavaScript API のオブジェクト モデルはより簡単に使用できるため、Word JavaScript APから始めることをお勧めします。次のような必要がある場合は、Word JavaScript API を使用します。We recommend that you start with the Word JavaScript API because the object model is easier to use. Use the Word JavaScript API if you need to:

  • Word 文書内のオブジェクトにアクセスする。Access the objects in a Word document.

次のような必要がある場合は、共有の JavaScript API for Office を使用します。Use the shared JavaScript API for Office when you need to:

  • Word 2013 を対象とする。Target Word 2013.
  • アプリケーションの初期アクションを実行する。Perform initial actions for the application.
  • サポートされている要件セットを確認する。Check the supported requirement set.
  • メタデータ、設定、およびドキュメントの環境情報にアクセスする。Access metadata, settings, and environmental information for the document.
  • ドキュメント内のセクションにバインドし、イベントをキャプチャする。Bind to sections in a document and capture events.
  • カスタム XML パーツを使用する。Use custom XML parts.
  • ダイアログ ボックスを開く。Open a dialog box.

次の手順Next steps

最初の Word アドインを作成する準備はできましたか?「最初の Word アドインをビルドする」を参照してください。また、対話式の「作業の開始エクスペリエンス」も使用できます。アドインのマニフェストを使用して、アドインがホストされている場所や表示方法の説明と、アクセス許可およびその他の情報の定義を行います。Ready to create your first Word add-in? See Build your first Word add-in. You can also try our interactive Get started experience. Use the add-in manifest to describe where your add-in is hosted, how it is displayed, and define permissions and other information.

ユーザーにとって魅力的なエクスペリエンスを提供する世界クラスの Word アドインを設計する方法の詳細については、「設計のガイドライン」と「ベスト プラクティス」を参照してください。To learn more about how to design a world class Word add-in that creates a compelling experience for your users, see Design guidelines and Best practices.

アドインを作成したら、ネットワーク共有、アプリ カタログ、または AppSource に発行できます。After you develop your add-in, you can publish it to a network share, an app catalog, or AppSource.

今後の Word アドインWhat's coming up for Word add-ins?

新しい Word アドイン用の API の設計と開発にあたり、API のオープン仕様ページでこれらに対するフィードバックの提供が可能になります。Word JavaScript API 用のパイプラインの新機能をご確認いただき、設計の仕様に関する情報をお寄せください。As we design and develop new APIs for Word add-ins, we'll make them available for your feedback on our API open specifications page. Find out what new features are in the pipeline for the Word JavaScript APIs, and provide your input on our design specifications.

関連項目See also