VBA とドキュメントレベルのカスタマイズを結合する

[アーティクル]
06/19/2023

Microsoft Office Word または Microsoft Office Excel 用のドキュメントレベルカスタマイズの一部であるドキュメント内で Visual Basic for Applications (VBA) コードを使用できます。カスタマイズアセンブリからドキュメント内の VBA コードを呼び出したり、ドキュメント内の VBA コードがカスタマイズアセンブリのコードを呼び出せるようにプロジェクトを構成したりすることができます。

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

ドキュメントレベルのカスタマイズでの VBA コードの動作

Visual Studio でプロジェクトを開くと、ドキュメントはデザインモードで開かれます。ドキュメントがデザインモードのときは VBA コードは実行しないので、VBA コードを実行しないでドキュメントとコードを作業できます。

ソリューションを実行すると、VBA およびカスタマイズアセンブリの両方のイベントハンドラーがドキュメント内で生成されたイベントを取得し、両方のコードセットが実行します。どちらのコードが先に実行するかは、事前にはわかりません。個別のケースごとにテストして判断する必要があります。 2 つのコードセットを慎重に調整およびテストしないと、予期しない結果になる可能性があります。

カスタマイズアセンブリから VBA コードを呼び出す

Word 文書のマクロおよび Excel ブックのマクロと関数を、呼び出すことができます。これを行うには、次のいずれかの方法を使用します。

Word の場合: Application クラスの Run メソッドを呼び出します。
Excel の場合: Run クラスの Application メソッドを呼び出します。

いずれのメソッドも、1 番目のパラメーターは呼び出すマクロまたは関数の名前を示し、残りの省略可能なパラメーターではマクロまたは関数に渡すパラメーターを指定します。 1 番目のパラメーターは、Word と Excel で形式が異なる場合があります。
Word の場合、1 番目のパラメーターは、テンプレート、モジュール、およびマクロ名の任意の組み合わせが可能な文字列です。ドキュメントの名前を指定した場合、コードは、任意のドキュメントの任意のマクロではなく、現在のコンテキストに関連するドキュメントのマクロのみを実行できます。
Excel の場合、1 番目のパラメーターでは、マクロ名を指定する文字列、関数の場所を示す Range 、または登録された DLL (XLL) 関数の登録者 ID を渡すことができます。文字列を渡した場合、文字列はアクティブなシートのコンテキストで評価されます。

次のコード例では、Excel のドキュメントレベルプロジェクトから MyMacro という名前のマクロを呼び出す方法を示します。この例では、 MyMacro は Sheet1で定義されているものとします。

Globals.Sheet1.Application.Run("MyMacro", missing, missing, missing,
    missing, missing, missing, missing, missing, missing, missing,
    missing, missing, missing, missing, missing, missing, missing,
    missing, missing, missing, missing, missing, missing, missing,
    missing, missing, missing, missing, missing, missing);

Globals.Sheet1.Application.Run("MyMacro")

Note

Visual C# で省略可能なパラメーターの代わりにグローバル missing 変数を使用する方法については、「Office ソリューションのコードを記述する」を参照してください。

VBA からドキュメントレベルのカスタマイズ内のコードを呼び出す

ドキュメント内の Visual Basic for Applications (VBA) コードがカスタマイズアセンブリのコードを呼び出すことができるように、Word または Excel のドキュメントレベルプロジェクトを構成できます。これは、次のシナリオで役立ちます。

同じドキュメントに関連付けられているドキュメントレベルカスタマイズ内の機能を使用して、ドキュメント内の既存の VBA コードを拡張する場合。
ドキュメントで VBA コードを記述することによって、ドキュメントレベルカスタマイズ内で開発したサービスに、エンドユーザーがアクセスできるようにする場合。

Visual Studio の Office 開発ツールには、VSTO アドインと同様の機能が用意されています。VSTO アドインを開発している場合は、他の Microsoft Office ソリューションから VSTO アドインのコードを呼び出すことができます。詳細については、「他の Office ソリューションから VSTO アドインのコードを呼び出す」を参照してください。

Note

この機能は、Word テンプレートプロジェクトでは使用できません。 Word 文書、Excel ブック、または Excel テンプレートの各プロジェクトでのみ使用できます。

要件

VBA コードでカスタマイズアセンブリを呼び出すことができるためには、プロジェクトが次の要件を満たしている必要があります。

ドキュメントは、次のいずれかのファイル名拡張子であることが必要です。
- Word の場合: .docm または .doc
- Excel の場合: .xlsm、.xltm、.xls、または .xlt
ドキュメントは、VBA コードが含まれる VBA プロジェクトを既に含んでいる必要があります。
ドキュメント内の VBA コードは、マクロの有効化をユーザーに確認することなく実行できる必要があります。 Word または Excel のセキュリティセンター設定の信頼できる場所の一覧に Office プロジェクトの場所を追加することによって、VBA コードの実行を信頼することができます。
Office プロジェクトは、ユーザーが VBA に公開した 1 つ以上のパブリックメンバーを含むパブリッククラスを、1 つ以上含んでいる必要があります。

メソッド、プロパティ、およびイベントを VBA に公開できます。公開できるクラスは、ホスト項目クラス (Word の ThisDocument 、Excel の ThisWorkbook や Sheet1 など) またはプロジェクト内で定義されている別のクラスです。ホスト項目の詳細については、「ホスト項目とホストコントロールの概要」を参照してください。

VBA コードでカスタマイズアセンブリを呼び出せるようにする

ドキュメント内の VBA コードにカスタマイズアセンブリ内のメンバーを公開するには 2 つの方法があります。

Visual Basic プロジェクトのホスト項目クラスのメンバーを VBA に公開できます。そのためには、ホスト項目 (つまり、文書、ワークシート、ブック) をデザイナーで開いた状態にして、[ プロパティ ] ウィンドウでホスト項目の EnableVbaCallers プロパティを True に設定します。 VBA コードがクラスのメンバーを呼び出せるようにするために必要なすべての処理は、Visual Studio が自動的に実行します。
Visual C# プロジェクトのパブリッククラスのメンバー、または Visual Basic プロジェクトの非ホスト項目クラスのメンバーを、VBA に公開できます。この方法を使用すると、VBA に公開するクラスをいっそう自由に選択できますが、必要な手動手順も多くなります。

そのためには、次の主要な手順を実行する必要があります。
1. COM にクラスを公開します。
2. プロジェクトでホスト項目クラスの GetAutomationObject メンバーをオーバーライドして、VBA に公開したクラスのインスタンスを返すようにします。
3. プロジェクトでホスト項目クラスの ReferenceAssemblyFromVbaProject プロパティを Trueに設定します。これにより、カスタマイズアセンブリのタイプライブラリがアセンブリに埋め込まれ、タイプライブラリへの参照がドキュメントの VBA プロジェクトに追加されます。
詳細については、「方法: Visual Basic プロジェクトのコードを VBA に公開する」および「方法: Visual C# プロジェクトのコードを VBA に公開する」を参照してください。

EnableVbaCallers および ReferenceAssemblyFromVbaProject プロパティは、設計時にのみ [ プロパティ ] ウィンドウで使用できます。実行時には使用できません。プロパティを表示するには、Visual Studio でホスト項目のデザイナーを開きます。これらのプロパティを設定した場合に Visual Studio で実行される具体的なタスクの詳細については、「ホスト項目プロパティによって実行されるタスク」を参照してください。

Note

ブックまたはドキュメントに VBA コードがまだ含まれていない場合、またはドキュメント内の VBA コードの実行が信頼されていない場合は、 EnableVbaCallers または ReferenceAssemblyFromVbaProject プロパティを Trueに設定するとエラーメッセージが表示されます。これは、このような状況では、Visual Studio がドキュメントのVBA プロジェクトを変更できないためです。

VBA コードのメンバーを使用してカスタマイズアセンブリを呼び出す

VBA コードがカスタマイズアセンブリを呼び出せるようにプロジェクトを構成すると、Visual Studio は次のメンバーをドキュメントの VBA プロジェクトに追加します。

すべてのプロジェクトに対し、Visual Studio は GetManagedClassという名前のグローバルメソッドを追加します。
EnableVbaCallers プロパティを使用してホスト項目クラスのメンバーを公開した Visual Basic プロジェクトの場合は、Visual Studio は CallVSTOAssembly という名前のプロパティも、VBA プロジェクトの ThisDocument、ThisWorkbook、Sheet1、Sheet2、または Sheet3 モジュールに追加します。

プロジェクトの VBA コードに公開したクラスのパブリックメンバーには、 CallVSTOAssembly プロパティまたは GetManagedClass メソッドを使用してアクセスできます。

Note

ソリューションを開発および配置するとき、ドキュメントの複数の異なるコピーに VBA コードを追加できます。詳細については、「ドキュメントに VBA コードを追加するためのガイドライン」を参照してください。

Visual Basic プロジェクトで CallVSTOAssembly プロパティを使用する

ホスト項目クラスに追加したパブリックメンバーにアクセスするには、 CallVSTOAssembly プロパティを使用します。たとえば、次の VBA マクロは、Excel ブックプロジェクトの MyVSTOMethod クラスで定義されている Sheet1 という名前のメソッドを呼び出します。

Sub MyMacro()
    Sheet1.CallVSTOAssembly.MyVSTOMethod()
End Sub

カスタマイズアセンブリを呼び出すには、 GetManagedClass メソッドを直接使うより、このプロパティを使う方が便利です。 CallVSTOAssembly は、VBA に公開されたホスト項目クラスを表すオブジェクトを返します。返されるオブジェクトのメンバーおよびメソッドパラメーターは、IntelliSense に表示されます。

CallVSTOAssembly プロパティには、次のコードのような宣言があります。このコードでは、 Sheet1 という名前の Excel ブックプロジェクトの ExcelWorkbook1 ホスト項目クラスを VBA に公開してあるものとします。

Property Get CallVSTOAssembly() As ExcelWorkbook1.Sheet1
    Set CallVSTOAssembly = GetManagedClass(Me)
End Property

GetManagedClass メソッドを使用する

グローバル GetManagedClass メソッドを使用するには、 GetAutomationObject メソッドのオーバーライドを含むホスト項目クラスに対応する VBA オブジェクトを渡します。次に、返されたオブジェクトを使用して、VBA に公開されているクラスにアクセスします。

たとえば、次の VBA マクロは、 MyVSTOMethod という名前の Excel ブックプロジェクトの Sheet1 ホスト項目クラスで定義されている ExcelWorkbook1という名前のメソッドを呼び出します。

Sub CallVSTOMethod
    Dim VSTOSheet1 As ExcelWorkbook1.Sheet1
    Set VSTOSheet1 = GetManagedClass(Sheet1)
    VSTOSheet1.MyVSTOMethod
End Sub

GetManagedClass メソッドの宣言は次のとおりです。

GetManagedClass(pdispInteropObject Object) As Object

このメソッドは、VBA に公開されたクラスを表すオブジェクトを返します。返されるオブジェクトのメンバーおよびメソッドパラメーターは、IntelliSense に表示されます。

ドキュメントに VBA コードを追加するためのガイドライン

ドキュメントの複数の異なるコピーに、ドキュメントレベルカスタマイズを呼び出す VBA コードを追加できます。

ソリューションの開発およびテスト時には、Visual Studio でのプロジェクトのデバッグまたは実行中に開かれるドキュメント (つまり、ビルド出力フォルダー内のドキュメント) に VBA コードを記述できます。ただし、Visual Studio はビルド出力フォルダー内のドキュメントをメインプロジェクトフォルダーからのドキュメントのコピーで置き換えるので、このドキュメントに追加したすべての VBA は次にプロジェクトをビルドすると上書きされます。

ソリューションのデバッグまたは実行の間にドキュメントに追加した VBA コードを保存する必要がある場合は、プロジェクトフォルダーのドキュメントに VBA コードをコピーします。ビルドプロセスの詳細については、「office ソリューションのビルド」を参照してください。

ソリューションを配置する準備ができたら、主に次の 3 つの場所のドキュメントに VBA コードを追加できます。

開発用コンピューターのプロジェクトフォルダー内

ドキュメント内の VBA コードとカスタムコードの両方を完全に制御できる場合は、この場所が便利です。ドキュメントは開発用コンピューター上にあるため、カスタムコードを変更する場合は VBA コードを簡単に変更できます。このドキュメントコピーに追加した VBA コードは、ソリューションをビルド、デバッグ、公開してもドキュメントに残ります。

ドキュメントがデザイナーで開かれているときは、ドキュメントに VBA コードを追加できません。最初にデザイナーでドキュメントを閉じてから、Word または Excel で直接ドキュメントを開く必要があります。

注意

ドキュメントを開くと実行される VBA コードを追加した場合は、まれに、このコードによってドキュメントが破壊されたり、デザイナーでドキュメントが開かなくなってしまったりする可能性があります。

公開フォルダーまたはインストールフォルダー内

場合によっては、公開フォルダーまたはインストールフォルダーのドキュメントに VBA コードを追加するのが適切な場合があります。たとえば、Visual Studio がインストールされていないコンピューターを使用する別の開発者によって VBA コードが作成およびテストされる場合、このオプションを選択することがあります。

ユーザーが公開フォルダーからソリューションを直接インストールする場合、ソリューションを公開するたびにドキュメントに VBA コードを追加する必要があります。 Visual Studio は、ソリューションが公開される公開場所のドキュメントを上書きします。

ユーザーが公開フォルダーとは異なるインストールフォルダーからソリューションをインストールする場合は、ソリューションを公開するたびにドキュメントに VBA コードを追加する必要はありません。公開の更新を公開フォルダーからインストールフォルダーに移動する準備ができたら、ドキュメント以外のすべてのファイルをインストールフォルダーにコピーします。

エンドユーザーのコンピューター上

ドキュメントレベルカスタマイズで提供されるサービスを呼び出す VBA 開発者がエンドユーザーである場合、ドキュメントのコピーの CallVSTOAssembly プロパティまたは GetManagedClass メソッドを使用して、コードの呼び出し方法をユーザーに伝えることができます。ソリューションに対して更新プログラムを発行しても、エンドユーザーコンピューター上のドキュメントの VBA コードは上書きされません。これは、更新プログラムの発行によってドキュメントが変更されることはないためです。

ホスト項目のプロパティによって実行されるタスク

EnableVbaCallers および ReferenceAssemblyFromVbaProject プロパティを使用するとき、Visual Studio は異なるタスクセットを実行します。

プロパティ

Visual Basic プロジェクトでホスト項目の EnableVbaCallers プロパティを True に設定すると、Visual Studio は次のタスクを実行します。

ComClassAttribute および ComVisibleAttribute 属性をホスト項目クラスに追加します。
ホスト項目クラスの GetAutomationObject メソッドをオーバーライドします。
ホスト項目の ReferenceAssemblyFromVbaProject プロパティを Trueに設定します。

EnableVbaCallers プロパティを Falseに戻すと、Visual Studio は次のタスクを実行します。
ComClassAttribute および ComVisibleAttribute 属性を ThisDocument クラスから削除します。
GetAutomationObject メソッドをホスト項目クラスから削除します。

Note

Visual Studio は、自動的には ReferenceAssemblyFromVbaProject プロパティの設定を Falseに戻しません。このプロパティは、[ プロパティ ] ウィンドウを使用して手動で False に設定できます。

ReferenceAssemblyFromVbaProject

Visual Basic または Visual C# プロジェクトでホスト項目の ReferenceAssemblyFromVbaProject プロパティを Trueに設定すると、Visual Studio は次のタスクを実行します。

カスタマイズアセンブリのタイプライブラリを生成し、タイプライブラリをアセンブリに埋め込みます。
次のタイプライブラリへの参照をドキュメントの VBA プロジェクトに追加します。
- カスタマイズアセンブリのタイプライブラリ。
- Microsoft Visual Studio Tools for Office Execution Engine 9.0 のタイプライブラリ。このタイプライブラリは、Visual Studio Tools for Office ランタイムに含まれています。
ReferenceAssemblyFromVbaProject プロパティを Falseに戻すと、Visual Studio は次のタスクを実行します。
ドキュメントの VBA プロジェクトから、タイプライブラリの参照を削除します。
アセンブリから埋め込まれているタイプライブラリを削除します。

トラブルシューティング

次の表では、一般的なエラーと、エラーを修正するための提案を示します。

エラー	推奨事項
EnableVbaCallers または ReferenceAssemblyFromVbaProject プロパティを設定した後、ドキュメントに VBA プロジェクトが含まれていない、またはドキュメント内の VBA プロジェクトに対するアクセス許可がないことを示すエラーメッセージが表示される。	プロジェクト内のドキュメントに少なくとも 1 つの VBA マクロが含まれていること、VBA プロジェクトに実行するための十分な信頼があること、および VBA プロジェクトがパスワードによって保護されていないことを確認します。
EnableVbaCallers または ReferenceAssemblyFromVbaProject プロパティを設定した後、GuidAttribute 宣言が存在しないか破損していることを示すエラーメッセージが表示されます。	GuidAttribute 宣言がプロジェクトの AssemblyInfo.cs または AssemblyInfo.vb ファイルにあること、およびこの属性に有効な GUID が設定されていることを確認します。
EnableVbaCallers または ReferenceAssemblyFromVbaProject プロパティを設定した後、AssemblyVersionAttribute によって指定されたバージョン番号が無効であることを示すエラーメッセージが表示されます。	プロジェクトの AssemblyInfo.cs または AssemblyInfo.vb ファイルに含まれる AssemblyVersionAttribute 宣言に、有効なアセンブリバージョン番号が設定されていることを確認します。有効なアセンブリのバージョン番号については、 AssemblyVersionAttribute クラスを参照してください。
カスタマイズアセンブリの名前を変更した後、カスタマイズアセンブリを呼び出す VBA コードが動作を停止する。	VBA コードに公開した後でカスタマイズアセンブリの名前を変更すると、ドキュメントの VBA プロジェクトとカスタマイズアセンブリの間のリンクが切れます。この問題を解決するには、プロジェクトで ReferenceFromVbaAssembly プロパティを False に変更した後、 Trueに戻して、VBA コード内にある古いアセンブリ名への参照を新しいアセンブリ名に置き換えます。

VBA とドキュメントレベルのカスタマイズを結合する

ドキュメントレベルのカスタマイズでの VBA コードの動作

カスタマイズアセンブリから VBA コードを呼び出す

VBA からドキュメントレベルのカスタマイズ内のコードを呼び出す

要件

VBA コードでカスタマイズアセンブリを呼び出せるようにする

VBA コードのメンバーを使用してカスタマイズアセンブリを呼び出す

Visual Basic プロジェクトで CallVSTOAssembly プロパティを使用する

GetManagedClass メソッドを使用する

ドキュメントに VBA コードを追加するためのガイドライン

開発用コンピューターのプロジェクトフォルダー内

公開フォルダーまたはインストールフォルダー内

エンドユーザーのコンピューター上

ホスト項目のプロパティによって実行されるタスク

プロパティ

ReferenceAssemblyFromVbaProject

トラブルシューティング

フィードバック

フィードバック

その他のリソース

VBA とドキュメントレベルのカスタマイズを結合する

ドキュメントレベルのカスタマイズでの VBA コードの動作

カスタマイズ アセンブリから VBA コードを呼び出す

VBA からドキュメントレベルのカスタマイズ内のコードを呼び出す

要件

VBA コードでカスタマイズ アセンブリを呼び出せるようにする

VBA コードのメンバーを使用してカスタマイズ アセンブリを呼び出す

Visual Basic プロジェクトで CallVSTOAssembly プロパティを使用する

GetManagedClass メソッドを使用する

ドキュメントに VBA コードを追加するためのガイドライン

開発用コンピューターのプロジェクト フォルダー内

公開フォルダーまたはインストール フォルダー内

エンド ユーザーのコンピューター上

ホスト項目のプロパティによって実行されるタスク

プロパティ

ReferenceAssemblyFromVbaProject

トラブルシューティング

関連するコンテンツ

フィードバック

フィードバック

その他のリソース

カスタマイズアセンブリから VBA コードを呼び出す

VBA コードでカスタマイズアセンブリを呼び出せるようにする

VBA コードのメンバーを使用してカスタマイズアセンブリを呼び出す

開発用コンピューターのプロジェクトフォルダー内

公開フォルダーまたはインストールフォルダー内

エンドユーザーのコンピューター上