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

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

必須条件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? OneNote

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

ウィザードを完了すると、ジェネレーターによってプロジェクトが作成されて、サポートしているノード コンポーネントがインストールされます。After you complete the wizard, the generator will create the project and install 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.

  • プロジェクトのルートディレクトリにある ./ 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.

コードを更新するUpdate the code

コード エディターでファイル ./src/taskpane/taskpane.js を開き、次のコードを 実行 関数内に追加します。In your code editor, open the file ./src/taskpane/taskpane.js and add the following code within the run function. このコードは、OneNote JavaScript API を使用してページ タイトルを設定し、ページの本文にアウトラインを追加します。This code uses the OneNote JavaScript API to set the page title and add an outline to the body of the page.

try {
    await OneNote.run(async context => {

        // Get the current page.
        var page = context.application.getActivePage();

        // Queue a command to set the page title.
        page.title = "Hello World";

        // Queue a command to add an outline to the page.
        var html = "<p><ol><li>Item #1</li><li>Item #2</li></ol></p>";
        page.addOutline(40, 90, html);

        // Run the queued commands, and return a promise to indicate task completion.
        return context.sync();
    });
} catch (error) {
    console.log("Error: " + error);
}

試してみるTry it out

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

    cd "My Office Add-in"
    
  2. ローカル Web サーバーを起動し、アドインのサイドロードを行います。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 will start.

    npm run dev-server
    

    プロジェクトのルート ディレクトリから次のコマンドを実行します。Run the following command in the root directory of your project. このコマンドを実行すると、ローカル Web サーバーが起動します (まだ実行されていない場合)。When you run this command, the local web server will start.

    npm run start:web
    
  3. OneNote on the web でノートブックを開き、新しいページを作成します。In OneNote on the web, open a notebook and create a new page.

  4. [挿入] > [Office アドイン] の順に選択し、[Office アドイン] ダイアログを開きます。Choose Insert > Office Add-ins to open the Office Add-ins dialog.

    • コンシューマー アカウントでサインインしている場合は、[マイ アドイン] タブを選択し、[マイ アドインのアップロード] を選択します。If you're signed in with your consumer account, select the MY ADD-INS tab, and then choose Upload My Add-in.

    • 職場または学校アカウントでサインインしている場合は、[自分の所属組織] タブを選択し、[マイ アドインのアップロード] を選択します。If you're signed in with your work or school account, select the MY ORGANIZATION tab, and then select Upload My Add-in.

    次の図は、コンシューマー ノートブックの [マイ アドイン] タブを示しています。The following image shows the MY ADD-INS tab for consumer notebooks.

    The Office Add-ins dialog showing the MY ADD-INS tab
  5. [アドインのアップロード] ダイアログで、プロジェクト フォルダー内の manifest.xml を参照し、[アップロード] を選択します。In the Upload Add-in dialog, browse to manifest.xml in your project folder, and then choose Upload.

  6. [ホーム] タブから、リボンの [作業ウィンドウの表示] ボタンをクリックします。From the Home tab, choose the Show Taskpane button in the ribbon. アドインの作業ウィンドウは、OneNote ページの横にある iFrame で開きます。The add-in task pane opens in an iFrame next to the OneNote page.

  7. 作業ウィンドウの下部にある [実行] リンクをクリックしてページ タイトルを設定し、ページの本文にアウトラインを追加します。At the bottom of the task pane, choose the Run link to set the page title and add an outline to the body of the page.

    このチュートリアルでビルドした OneNote アドイン

次の手順Next steps

おめでとうございます。OneNote の作業ウィンドウ アドインが正常に作成されました。Congratulations, you've successfully created a Word task pane add-in! 次に、OneNote アドイン構築の中心概念の詳細について説明します。Next, learn more about the core concepts of building OneNote add-ins.

関連項目See also