チュートリアル : 初めての Excel 用アプリケーションレベルのアドインの作成

[アーティクル]
02/21/2013

この入門編のチュートリアルでは、Microsoft Office Excel 用のアプリケーションレベルのアドインを作成する方法について説明します。この種のソリューションに作成した機能は、どのブックが開いているかにかかわらず、アプリケーション自体に対して使用できます。

対象: このトピックの情報は、Excel 2013 と Excel 2010 のアプリケーションレベルのプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクトタイプ別の使用可能な機能」を参照してください。

このチュートリアルでは、次の作業について説明します。

Excel 用の Excel アドインプロジェクトを作成する。
Excel のオブジェクトモデルを使用して保存時にテキストをブックに追加するコードを記述する。
プロジェクトをビルドし、実行してテストする。
完成したプロジェクトをクリーンアップして、開発用コンピューターでこのアドインが自動的に実行されないようにする。

[!メモ]

お使いのマシンで、Visual Studio ユーザーインターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

Microsoft Office Developer Tools が含まれているエディションの Visual Studio 2012。詳細については、「[Office ソリューションを開発できるようにコンピューターを構成する](bb398242\(v=vs.110\).md)」を参照してください。

Excel 2013 または Excel 2010。

プロジェクトの作成

Visual Studio で新しい Excel アドインプロジェクトを作成するには

Visual Studio を起動します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
テンプレートペインで、または [Visual C#] **[Visual Basic]を展開し、[Office/SharePoint]**を展開します。
[Office/SharePoint] の展開したノードの下で、[Office Add-ins] のノードを選択します。
プロジェクトテンプレートの一覧で、[Excel 2010 アドイン] または [Excel 2013 アドイン] を選択します。
[プロジェクト名] ボックスに「FirstExcelAddIn」と入力します。
[OK] をクリックします。

Visual Studio により FirstExcelAddIn プロジェクトが作成され、ThisAddIn コードファイルがエディターで開かれます。

保存するブックにテキストを追加するコードの記述

次に、ThisAddIn コードファイルにコードを追加します。この新しいコードでは、Excel のオブジェクトモデルを使用して、アクティブなワークシートの最初の行に定型句を挿入します。アクティブなワークシートとは、ユーザーがワークシートを保存したときに開いているワークシートです。ThisAddIn コードファイルには、次のコードが既定で含まれています。

ThisAddIn クラスの部分定義。このクラスは、コードのエントリポイントを提供し、Excel のオブジェクトモデルへのアクセスを提供します。詳細については、「アプリケーションレベルのアドインのプログラミング」を参照してください。ThisAddIn クラスの残りの部分は、変更することができない非表示のコードファイルに定義されています。
ThisAddIn_Startup イベントハンドラーおよび ThisAddIn_Shutdown イベントハンドラー。これらのイベントハンドラーは、Excel がアドインを読み込むときとアンロードするときに呼び出されます。これらのイベントハンドラーを使用して、読み込まれるときにはアドインを初期化し、アンロードされるときにはアドインが使用したリソースをクリーンアップします。詳細については、「Office プロジェクトのイベント」を参照してください。

保存するブックにテキストの行を追加するには

ThisAddIn コードファイルで、次のコードを ThisAddIn クラスに追加します。この新しいコードでは、ブックが保存されるときに発生する WorkbookBeforeSave イベントのイベントハンドラーを定義します。

ユーザーがブックを保存すると、イベントハンドラーによって新しいテキストがアクティブなワークシートの先頭に追加されます。

Private Sub Application_WorkbookBeforeSave(ByVal Wb As Microsoft.Office.Interop.Excel.Workbook, ByVal SaveAsUI As Boolean, ByRef Cancel As Boolean) Handles Application.WorkbookBeforeSave
    Dim activeWorksheet As Excel.Worksheet = CType(Application.ActiveSheet, Excel.Worksheet)
    Dim firstRow As Excel.Range = activeWorksheet.Range("A1")
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown)
    Dim newFirstRow As Excel.Range = activeWorksheet.Range("A1")
    newFirstRow.Value2 = "This text was added by using code"
End Sub

void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI, ref bool Cancel)
{
    Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet);
    Excel.Range firstRow = activeWorksheet.get_Range("A1");
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown);
    Excel.Range newFirstRow = activeWorksheet.get_Range("A1");
    newFirstRow.Value2 = "This text was added by using code";
}

C# を使用している場合は、次の必須のコードを ThisAddIn_Startup イベントハンドラーに追加します。このコードは、Application_WorkbookBeforeSave イベントハンドラーを WorkbookBeforeSave イベントに接続するために使用します。
```
this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);
```

保存時にブックを変更するために、前のコード例では次のオブジェクトを使用しています。

ThisAddIn クラスの Application フィールド。Application フィールドは Excel の現在のインスタンスを表す Microsoft.Office.Interop.Excel.Application オブジェクトを返します。
WorkbookBeforeSave イベントのイベントハンドラーの Wb パラメーター。Wb パラメーターは、保存されるブックを表す Microsoft.Office.Interop.Excel.Workbook オブジェクトです。詳細については、「Excel オブジェクトモデルの概要」を参照してください。

プロジェクトのテスト

プロジェクトをテストするには

F5 キーを押して、プロジェクトをビルドおよび実行します。

プロジェクトをビルドすると、コードはアセンブリにコンパイルされ、プロジェクトのビルド出力フォルダーに保存されます。さらに Visual Studio は、Excel がアドインを検出して読み込むようにする一連のレジストリエントリを作成し、アドインを実行できるように開発用コンピューター上のセキュリティを設定します。詳細については、「Office ソリューションのビルド」を参照してください。
Excel で、ブックを保存します。
次のテキストがブックに追加されることを確認します。

This text was added by using code.
Excel を終了します。

プロジェクトのクリーンアップ

プロジェクトの開発を完了したら、アドインアセンブリ、レジストリエントリ、およびセキュリティ設定を開発用コンピューターから削除します。この操作を行わないと、今後も開発用コンピューター上で Excel を起動するたびにアドインが実行されます。

開発用コンピューターから完成したプロジェクトをクリーンアップするには

Visual Studio で、[ビルド] メニューの [ソリューションのクリーン] をクリックします。

次の手順

Excel 用の基本的なアプリケーションレベルのアドインを作成した後は、アドインの作成方法の詳細について、以下のトピックを参照してください。

アドインで実行できる一般的なプログラミングタスク : アプリケーションレベルのアドインのプログラミング
Excel アドインに固有のプログラミングタスク : Excel ソリューション
Excel のオブジェクトモデルドキュメントの使用 : Excel オブジェクトモデルの概要
Excel のユーザーインターフェイス (UI: User Interface) のカスタマイズ (リボンへのカスタムタブの追加、独自のカスタム作業ウィンドウの作成など) : Office UI のカスタマイズ
Excel 用のアプリケーションレベルのアドインのビルドとデバッグ : Office ソリューションのビルド
Excel 用のアプリケーションレベルのアドインの配置 : Office ソリューションの配置