最初の Word の作業ウィンドウ アドインを作成するBuild your first Word task pane add-in

対象: Windows 用 Word 2016 以降、Word on iPad および MacApplies to: Word 2016 or later on Windows, and Word on iPad and Mac

この記事では、Word の作業ウィンドウ アドインを作成するプロセスを紹介します。In this article, you'll walk through the process of building a Word task pane add-in.

アドインを作成するCreate the add-in

Office アドインの Yeoman ジェネレーター または Visual Studio を使用して Office アドインを作成することができます。You can create an Office Add-in by using the Yeoman generator for Office Add-ins or Visual Studio. Yeoman ジェネレーターでは Visual Studio Code またはその他のエディターで管理できる Node.js プロジェクトを作成します。一方、Visual Studio では Visual Studio のソリューションを作成します。The Yeoman generator creates a Node.js project that can be managed with Visual Studio Code or any other editor, whereas Visual Studio creates a Visual Studio solution. 使いたい方のタブを選択し、アドインを作成する手順に従ってローカルでアドインをテストします。Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally.

前提条件Prerequisites

  • Node.js (バージョン 8.0.0 以降)Node.js (version 8.0.0 or later)

  • GitGit

  • 最新バージョンの YeomanOffice アドイン用の Yeoman ジェネレーター。これらのツールをグローバルにインストールするには、コマンド プロンプトから次のコマンドを実行します。The latest version of Yeoman and the Yeoman generator for Office Add-ins. To install these tools globally, run the following command via the command prompt:

    npm install -g yo generator-office
    

    注意

    以前に一度使用したバージョンのジェネレーターをインストールしていた場合でも、パッケージを npm から最新バージョンに更新することをお勧めします。Even if you've previously installed the Yeoman generator, we recommend you update your package to the latest version from npm.

アドイン プロジェクトの作成Create the add-in project

次のコマンドを実行して、[ごみ箱] ジェネレーターを使用してアドインプロジェクトを作成します。Run the following command to create an add-in project using the Yeoman generator:

yo office

注意

yo officeコマンドを実行すると、Office アドインのデータ収集ポリシーに関するダイアログボックスが表示されることがあります。When you run the yo office command, you may receive prompts about the data collection policies of Yeoman and the Office Add-in CLI tools. 提供されている情報を使用して、表示に適したプロンプトに応答します。Use the information that's provided to respond to the prompts as you see fit.

メッセージが表示されたら、アドインプロジェクトを作成するための次の情報を入力します。When prompted, provide the following information to create your add-in project:

  • Choose a project type: (プロジェクトの種類を選択) Office Add-in Task Pane projectChoose a project type: Office Add-in Task Pane project
  • Choose a script type: (スクリプトの種類を選択) JavascriptChoose a script type: Javascript
  • What would you want to name your add-in?: (アドインの名前を何にしますか)What do you want to name your add-in? My Office Add-in
  • Which Office client application would you like to support?: (どの Office クライアント アプリケーションをサポートしますか)Which Office client application would you like to support? Word

Yeoman ジェネレーターのプロンプトと応答のスクリーンショット

ウィザードを完了すると、ジェネレーターによってプロジェクトが作成されて、サポートしているノード コンポーネントがインストールされます。After you complete the wizard, the generator creates the project and installs supporting Node components.

ヒント

アドインプロジェクトを作成した後で、次の手順に従って、その後に実行することができます。You can ignore the next steps guidance that the Yeoman generator provides after the add-in project's been created. この記事で説明する手順では、このチュートリアルを完了するために必要なすべてのガイダンスについて説明します。The step-by-step instructions within this article provide all of the guidance you'll need to complete this tutorial.

プロジェクトを確認するExplore the project

Yeoman ジェネレーターで作成したアドイン プロジェクトには、とても基本的なアドインの作業ウィンドウが含まれています。The add-in project that you've created with the Yeoman generator contains sample code for a very basic task pane add-in. アドイン プロジェクトの構成要素を確認したい場合は、コード エディターでプロジェクトを開き、以下に一覧表示されているファイルを確認します。If you'd like to explore the components of your add-in project, open the project in your code editor and review the files listed below. アドインを試す準備ができたら、次のセクションに進みます。When you're ready to try out your add-in, proceed to the next section.

  • プロジェクトのルート ディレクトリにある ./manifest.xmlファイルで、アドインの機能と設定を定義します。The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
  • ./src/taskpane/taskpane.htmlファイルには、作業ウィンドウ用の HTML マークアップが含まれています。The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
  • ./src/taskpane/taskpane.cssファイルには、作業ウィンドウ内のコンテンツに適用される CSS が含まれています。The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • ./src/taskpane/taskpane.jsファイルには、作業ウィンドウと Office のホスト アプリケーションの間のやり取りを容易にする Office JavaScript API コードが含まれています。The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office host application.

試してみるTry it out

  1. プロジェクトのルート フォルダーに移動します。Navigate to the root folder of the project.

    cd "My Office Add-in"
    
  2. 以下の手順を実行し、ローカル Web サーバーを起動してアドインのサイドロードを行います。Complete the following steps to start the local web server and sideload your add-in.

    注意

    開発の最中でも、OfficeアドインはHTTPではなくHTTPSを使用する必要があります。Office Add-ins should use HTTPS, not HTTP, even when you are developing. 次のいずれかのコマンドを実行した後に証明書をインストールするように求められた場合は、Yeoman ジェネレーターによって提供される証明書をインストールするプロンプトを受け入れます。If you are prompted to install a certificate after you run one of the following commands, accept the prompt to install the certificate that the Yeoman generator provides.

    ヒント

    Mac でアドインをテストしている場合は、先に進む前に次のコマンドを実行してください。If you're testing your add-in on Mac, run the following command before proceeding. このコマンドを実行すると、ローカル Web サーバーが起動します。When you run this command, the local web server starts.

    npm run dev-server
    
    • Word でアドインをテストするには、プロジェクトのルート ディレクトリから次のコマンドを実行します。To test your add-in in Word, run the following command in the root directory of your project. ローカル Web サーバーが (まだ実行されていない場合) 起動し、アドインが読み込まれた Word が開きます。This starts the local web server (if it's not already running) and opens Word with your add-in loaded.

      npm start
      
    • ブラウザー上の Word でアドインをテストするには、プロジェクトのルート ディレクトリから次のコマンドを実行します。To test your add-in in Word on a browser, run the following command in the root directory of your project. このコマンドを実行すると、ローカル Web サーバーが起動します (まだ実行されていない場合)。When you run this command, the local web server will start (if it's not already running).

      npm run start:web
      

      アドインを使用するには、Word on the web で新しいドキュメントを開き、「Office on the web で Office アドインをサイドロードする」の手順に従ってアドインをサイドロードします。To use your add-in, open a new document in Word on the web and then sideload your add-in by following the instructions in Sideload Office Add-ins in Office on the web.

  3. Word で、新規のドキュメントを開き、[ホーム] タブを選択し、リボンの [作業ウィンドウの表示] ボタンをクリックして、アドインの作業ウィンドウを開きます。In Word, open a new document, choose the Home tab, and then choose the Show Taskpane button in the ribbon to open the add-in task pane.

    [作業ウィンドウの表示] ボタンが強調表示されている Word アプリケーションのスクリーンショット

  4. 作業ウィンドウの下部にある [実行] リンクを選択して、青のフォントで "Hello World" とテキストをドキュメントに追加します。At the bottom of the task pane, choose the Run link to add the text "Hello World" to the document in blue font.

    読み込まれた作業ウィンドウ アドインを用いた Word アプリケーションのスクリーンショット

次の手順Next steps

おめでとうございます。 Word の作業ウィンドウ アドインが正常に作成されました。Congratulations, you've successfully created a Word task pane add-in! 次に、Word アドインの機能の詳細について説明します。Word アドインのチュートリアルに従って、より複雑なアドインをビルドします。Next, learn more about the capabilities of a Word add-in and build a more complex add-in by following along with the Word add-in tutorial.

関連項目See also