チュートリアル : VBA から Visual C# プロジェクトのコードを呼び出す

[アーティクル]
08/09/2011

このチュートリアルでは、ブック内の Visual Basic for Applications (VBA) コードから Microsoft Office Excel 用のドキュメントレベルのカスタマイズ内のメソッドを呼び出す方法について説明します。この操作を実行するには、Sheet1 ホスト項目クラスにメソッドを追加し、そのメソッドをブック内の VBA コードに公開し、そのメソッドをブック内の VBA コードから呼び出すという主要な 3 つの手順を使用します。

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

このチュートリアルでは Excel を使用しますが、ここで説明する概念は Word 用のドキュメントレベルのプロジェクトにも該当します。

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

VBA コードを含むブックの作成
Excel のセキュリティセンターを使用した、ブックの場所に対する信頼の付与
Sheet1 ホスト項目クラスへのメソッドの追加
Sheet1 ホスト項目クラスのインターフェイスの抽出
VBA コードへのメソッドの公開
VBA コードからのメソッドの呼び出し

注意

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

必須コンポーネント

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

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

Excel 2007 または Excel 2010

VBA コードを含むブックの作成

まず、簡単な VBA マクロを含むマクロ有効ブックを作成します。カスタマイズ内のコードを VBA に公開するためには、ブックに VBA コードが含まれている必要があります。そうでない場合、Visual Studio は VBA コードがカスタマイズアセンブリを呼び出すことができるように VBA プロジェクトを変更できません。

使用する VBA コードが含まれる既存のブックがある場合は、この手順を省略できます。

VBA コードを含むブックを作成するには

Excel を起動します。
アクティブドキュメントを WorkbookWithVBA という名前の Excel マクロ有効ブック (*.xlsm) として保存します。このブックは、デスクトップなどの便利な場所に置きます。
リボンの [開発] タブをクリックします。

注意

[開発] タブが表示されていない場合は、最初にこれを表示する必要があります。詳細については、「方法 : [開発] タブをリボンに表示する」を参照してください。
[コード] グループの [Visual Basic] をクリックします。

Visual Basic エディターが開きます。
[プロジェクト] ウィンドウの [ThisWorkbook] をダブルクリックします。

ThisWorkbook オブジェクトのコードファイルが開きます。
コードファイルに次の VBA コードを追加します。このコードには、何も操作を実行しない簡単な関数が定義されています。この関数は、ブック内に VBA プロジェクトが存在することを確認することだけを目的としています。これは、このチュートリアルの後の手順で必要となります。
```
Sub EmptySub()
End Sub
```
文書を保存し、Excel を終了します。

プロジェクトの作成

次に、前の手順で作成したマクロ有効ブックを使用する、Excel 用のドキュメントレベルのプロジェクトを作成します。

新しいプロジェクトを作成するには

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

Visual Studio Tools for Office プロジェクトウィザードが開きます。
[既存のドキュメントをコピーする] を選択し、[既存のドキュメントの完全パス] ボックスで、前の手順で作成したブック WorkbookWithVBA の場所を指定します。独自に作成したマクロ有効ブックを使用する場合は、そのブックの場所を指定します。
[完了] をクリックします。

Visual Studio によって、デザイナーで WorkbookWithVBA ブックが開き、ソリューションエクスプローラーに CallingCodeFromVBA プロジェクトが追加されます。

ブックの場所に対する信頼の付与

ソリューションのコードをブック内の VBA コードに公開するためには、ブック内の VBA に実行についての信頼を付与する必要があります。これにはいくつかの方法があります。このチュートリアルでは、このタスクを実行するために、Excel のセキュリティセンターでブックの場所に信頼を付与します。

ブックの場所に信頼を付与するには

Excel を起動します。
[ファイル] タブ (Excel 2010 の場合) または Microsoft Office ボタン (Excel 2007 の場合) をクリックします。
[Excel のオプション] をクリックします。
カテゴリペインで、[セキュリティセンター] をクリックします。
詳細ペインで [セキュリティセンターの設定] をクリックします。
カテゴリペインで [信頼できる場所] をクリックします。
詳細ペインの [新しい場所の追加] をクリックします。
[Microsoft Office の信頼できる場所] ダイアログボックスで、CallingCodeFromVBA プロジェクトがあるフォルダーに移動します。
[この場所のサブフォルダーも信頼する] を選択します。
[Microsoft Office の信頼できる場所] ダイアログボックスで [OK] をクリックします。
[セキュリティセンター] ダイアログボックスで [OK] をクリックします。
[Excel のオプション] ダイアログボックスで [OK] をクリックします。
Excel を終了します。

Sheet1 クラスへのメソッドの追加

VBA プロジェクトのセットアップが完了したので、次に VBA コードから呼び出す Sheet1 ホスト項目クラスにパブリックメソッドを追加します。

Sheet1 クラスにメソッドを追加するには

ソリューションエクスプローラーで [Sheet1.cs] を右クリックし、[コードの表示] をクリックします。

コードエディターで Sheet1.cs ファイルが開きます。

Sheet1 クラスに次のコードを追加します。 CreateVstoNamedRange メソッドは、指定された範囲に新しい NamedRange オブジェクトを作成します。このメソッドは、NamedRange の Selected イベントを処理するイベントハンドラーも作成します。後の手順で、ドキュメント内の VBA コードから CreateVstoNamedRange メソッドを呼び出します。

private Microsoft.Office.Tools.Excel.NamedRange namedRange1;

public void CreateVstoNamedRange(Excel.Range range, string name)
{
    if (!this.Controls.Contains(name))
    {
        namedRange1 = this.Controls.AddNamedRange(range, name);
        namedRange1.Selected += new Excel.DocEvents_SelectionChangeEventHandler(
                namedRange1_Selected);
    }
    else
    {
        MessageBox.Show("A named range with this specific name " +
            "already exists on the worksheet.");
    }
}

private void namedRange1_Selected(Microsoft.Office.Interop.Excel.Range Target)
{
    MessageBox.Show("This named range was created by Visual Studio " +
        "Tools for Office.");
}

Sheet1 クラスに次のメソッドを追加します。このメソッドは、GetAutomationObject() メソッドをオーバーライドして、Sheet1 クラスの現在のインスタンスを返します。
```
protected override object GetAutomationObject()
{
    return this;
}
```
Sheet1 クラス宣言の第 1 行の前に次の属性を適用します。これらの属性によって、クラスインターフェイスを生成しなくても VBA に公開するクラスが COM から参照できるようになります。
```
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.ClassInterface(
    System.Runtime.InteropServices.ClassInterfaceType.None)]
```

Sheet1 クラスのインターフェイスの抽出

CreateVstoNamedRange メソッドを VBA コードに公開する前に、このメソッドが定義されたパブリックインターフェイスを作成し、そのインターフェイスを COM に公開する必要があります。

Sheet1 クラスのインターフェイスを抽出するには

Sheet1.cs コードファイルを開き、Sheet1 クラスの任意の位置をクリックします。
[リファクター] メニューの [インターフェイスの展開] をクリックします。
[インターフェイスの展開] ダイアログボックスの [インターフェイスからパブリックメンバーを選択してください] ボックスの一覧で、CreateVstoNamedRange メソッドのエントリをクリックします。
[OK] をクリックします。

Visual Studio は ISheet1 という名前の新しいインターフェイスを生成し、ISheet1 インターフェイスを実装するように Sheet1 クラスの定義を変更します。さらに、Visual Studio は ISheet1.cs ファイルをコードエディターで開きます。
ISheet1.cs ファイル内の ISheet1 インターフェイス宣言を次のコードに置き換えます。このコードによって、ISheet1 がパブリックインターフェイスになり、ComVisibleAttribute 属性の適用により、このインターフェイスが COM から参照できるようになります。
```
[System.Runtime.InteropServices.ComVisible(true)]
public interface ISheet1
{
    void CreateVstoNamedRange(Microsoft.Office.Interop.Excel.Range range, string name);
}
```
プロジェクトをビルドします。

VBA コードへのメソッドの公開

CreateVstoNamedRange メソッドをブック内の VBA コードに公開するには、Sheet1 ホスト項目の ReferenceAssemblyFromVbaProject プロパティを True に設定します。

VBA コードにメソッドを公開するには

ソリューションエクスプローラーで、Sheet1.cs をダブルクリックします。

デザイナーで WorkbookWithVBA ファイルが開き、Sheet1 が表示されます。
[プロパティ] ウィンドウで [ReferenceAssemblyFromVbaProject] プロパティを選択し、値を True に変更します。
表示されたメッセージで [OK] をクリックします。
プロジェクトをビルドします。

VBA コードからのメソッドの呼び出し

ここで、ブック内の VBA コードから CreateVstoNamedRange メソッドを呼び出すことができます。

注意

このチュートリアルでは、プロジェクトのデバッグ中に VBA コードをブックに追加します。このドキュメントに追加する VBA コードは、次にプロジェクトをビルドするときに上書きされます。これは、Visual Studio によって、ビルド出力フォルダー内のドキュメントが、メインプロジェクトフォルダーのドキュメントのコピーで置換されるためです。 VBA コードを保存する場合は、コードをプロジェクトフォルダー内のドキュメントにコピーします。詳細については、「VBA からドキュメントレベルのカスタマイズ内のコードを呼び出す」を参照してください。

VBA コードからメソッドを呼び出すには

F5 キーを押してプロジェクトを実行します。
[開発] タブの [コード] グループで [Visual Basic] をクリックします。

Visual Basic エディターが開きます。
[挿入] メニューの [モジュール] をクリックします。
新しいモジュールに次のコードを追加します。

このコードはカスタマイズアセンブリの CreateTable メソッドを呼び出します。マクロは、VBA コードに公開した Sheet1 ホスト項目クラスにアクセスする GetManagedClass メソッドを使用して、このメソッドにアクセスします。 GetManagedClass メソッドは、前の手順で ReferenceAssemblyFromVbaProject プロパティを設定したときに自動的に生成されています。
```
Sub CallVSTOMethod()
    Dim VSTOSheet1 As CallingCodeFromVBA.Sheet1
    Set VSTOSheet1 = GetManagedClass(Sheet1)
    Call VSTOSheet1.CreateVstoNamedRange(Sheet1.Range("A1"), "VstoNamedRange")
End Sub
```
F5 キーを押します。
ブックが開いたら、Sheet1 のセル A1 をクリックします。メッセージボックスが表示されることを確認します。
変更を保存せずに Excel を終了します。

次の手順

Office ソリューションのコードを VBA から呼び出す方法の詳細については、次の各トピックを参照してください。

VBA から Visual Basic カスタマイズのホスト項目のコードを呼び出す。このプロセスは Visual C# プロセスとは異なります。詳細については、「チュートリアル : VBA から Visual Basic プロジェクトのコードを呼び出す」を参照してください。
VBA からアプリケーションレベルのアドインのコードを呼び出す。詳細については、「チュートリアル : アプリケーションレベルのアドインのコードを VBA から呼び出す」を参照してください。