最初の Word の作業ウィンドウ アドインを作成する

対象: Windows 用 Word 2016 以降、Word on iPad および Mac

この記事では、Word の作業ウィンドウ アドインを作成するプロセスを紹介します。

アドインを作成する

Office アドインの Yeoman ジェネレーター または Visual Studio を使用して Office アドインを作成することができます。 Yeoman ジェネレーターでは Visual Studio Code またはその他のエディターで管理できる Node.js プロジェクトを作成します。一方、Visual Studio では Visual Studio のソリューションを作成します。 使いたい方のタブを選択し、アドインを作成する手順に従ってローカルでアドインをテストします。

ヒント

Yeoman ジェネレーターを使用してシングル サインオン (SSO) を使用するアドインを作成するには、「シングル サインオン (SSO) のクイック スタート」の手順を参照してください。

前提条件

注意

Node.js または npm に慣れていない場合は、まず開発環境をセットアップする必要があります。

  • Node.js (最新 LTS バージョン)

  • 最新バージョンの YeomanOffice アドイン用の Yeoman ジェネレーター。これらのツールをグローバルにインストールするには、コマンド プロンプトから次のコマンドを実行します。

    npm install -g yo generator-office
    

    注意

    Yeomanのジェネレーターを過去に取付けている場合でも、npmからのパッケージを最新のバージョンにすることをお勧めします。

アドイン プロジェクトの作成

次のコマンドを実行し、Yeoman ジェネレーターを使用してアドイン プロジェクトを作成します。

yo office

注意

yo officeコマンドを実行すると、Yeoman のデータ収集ポリシーと Office アドイン CLI ツールに関するプロンプトが表示される場合があります。 提供された情報を使用して、必要に応じてプロンプトに応答します。

プロンプトが表示されたら、以下の情報を入力してアドイン プロジェクトを作成します。

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

コマンド ライン インターフェイスでの Yeoman ジェネレーターのプロンプトと回答を示すスクリーンショット。

ウィザードを完了すると、ジェネレーターによってプロジェクトが作成されて、サポートしているノード コンポーネントがインストールされます。

ヒント

アドイン プロジェクトの作成後に Yeoman ジェネレーターが提供する次の手順ガイダンスは無視できます。 この記事中の詳しい手順は、このチュートリアルを完了するために必要なすべてのガイダンスを提供します。

プロジェクトを確認する

Yeoman ジェネレーターで作成したアドイン プロジェクトには、基本的なアドインの作業ウィンドウが含まれています。 アドイン プロジェクトの構成要素を確認したい場合は、コード エディターでプロジェクトを開き、以下に一覧表示されているファイルを確認します。 アドインを試す準備ができたら、次のセクションに進みます。

  • プロジェクトのルート ディレクトリにある ./manifest.xml ファイルで、アドインの機能と設定を定義します。 manifest.xml ファイルの詳細については、「Office アドインの XML マニフェスト」を参照してください。
  • ./src/taskpane/taskpane.html ファイルには、作業ペイン用のHTMLマークアップが含まれています。
  • ./src/taskpane/taskpane.css ファイルには、作業ペインのコンテンツに適用されるCSSが含まれています。
  • ./src/taskpane/taskpane.js ファイルには、作業ウィンドウと Office クライアント アプリケーションの間のやり取りを容易にする Office JavaScript API コードが含まれています。

試してみる

  1. プロジェクトのルート フォルダーに移動します。

    cd "My Office Add-in"
    
  2. 以下の手順を実行し、ローカル Web サーバーを起動してアドインのサイドロードを行います。

    注意

    開発の最中でも、OfficeアドインはHTTPではなくHTTPSを使用する必要があります。 次のいずれかのコマンドを実行した後に証明書をインストールするように求められた場合は、Yeoman ジェネレーターによって提供される証明書をインストールするプロンプトを受け入れます。

    ヒント

    Mac でアドインをテストしている場合は、先に進む前に次のコマンドを実行してください。 このコマンドを実行すると、ローカル Web サーバーが起動します。

    npm run dev-server
    
    • Word でアドインをテストするには、プロジェクトのルート ディレクトリから次のコマンドを実行します。 ローカル Web サーバーが (まだ実行されていない場合) 起動し、アドインが読み込まれた Word が開きます。

      npm start
      
    • ブラウザー上の Word でアドインをテストするには、プロジェクトのルート ディレクトリから次のコマンドを実行します。 このコマンドを実行すると、ローカル Web サーバーが起動します (まだ実行されていない場合)。

      npm run start:web
      

      アドインを使用するには、Word on the web で新しいドキュメントを開き、「Office on the web で Office アドインをサイドロードする」の手順に従ってアドインをサイドロードします。

  3. Word で、新規のドキュメントを開き、[ホーム] タブを選択し、リボンの [作業ウィンドウの表示] ボタンをクリックして、アドインの作業ウィンドウを開きます。

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

  4. 作業ウィンドウの下部にある [実行] リンクを選択して、青のフォントで "Hello World" というテキストをドキュメントに追加します。

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

次の手順

おめでとうございます。 Word の作業ウィンドウ アドインが正常に作成されました。 次に、Word アドインの機能の詳細説明と、より複雑なアドインを作成する方法について、「Word アドインのチュートリアル」をご覧ください。

関連項目