方法 : マクロで特定の種類のプロジェクト用のイベントハンドラーを作成する

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

すべてのマクロプロジェクトに含まれている EnvironmentEvents テンプレートには、宣言済みのイベントハンドラーが数多く含まれています。これらのイベントハンドラーは、ウィンドウを閉じるなど、多くの環境イベントに応答するために実装できます。実装が提供されると、汎用機能拡張イベントハンドラーは、指定したイベントが Visual Studio 統合開発環境 (IDE: Integrated Development Environment) で発生するたびに、それを自動的に受け取ります。詳細については、「方法: マクロで環境イベントを処理する」を参照してください。

また、独自の IDE イベントハンドラーを EnvironmentEvents テンプレートに追加することもできます。イベント変数を宣言して、その変数にイベントハンドラーコードを指定し、OnMacrosRuntimeReset ハンドラーおよび OnStartupComplete ハンドラーを追加することで、Visual Studio IDE でのイベントの受け取りを自動化します。

この例では、Visual C# プロジェクトまたは Visual Basic プロジェクトに参照を追加した場合に発生する ReferencesEvents イベントハンドラーを追加します。

注意

実際に画面に表示されるダイアログボックスとメニューコマンドは、アクティブな設定またはエディションによっては、ヘルプの説明と異なる場合があります。ここに記載されている手順は、全般的な開発設定が適用されているものとして記述されています。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「設定の操作」を参照してください。

VSLangProj イベントハンドラーをマクロに追加するには

マクロ IDE で、[プロジェクト] メニューの [参照の追加] をクリックします。
[参照の追加] ダイアログボックスで、[VSLangProj] を選択します。[追加] をクリックし、[OK] をクリックします。
マクロ IDE のクラスビュー エクスプローラーペインで、[MyMacros] を展開し、[EnvironmentEvents] をダブルクリックしてマクロエディターペインに表示します。
EnvironmentEvents モジュールの先頭に、次の宣言を追加します。
```
Imports VSLangProj
```
"Automatically generated code, do not modify" というラベルの付いた EnvironmentEvents モジュールの非表示領域の後に、次のようにイベントの宣言を入力します。
```
<System.ContextStaticAttribute()> Public WithEvents refEvents As VSLangProj.ReferencesEvents
```
この宣言では、ReferencesEvents およびそのメソッドを、マクロ IDE コードエディターの [クラス名] ボックスの一覧と [メソッド名] ボックスの一覧に追加します。
[クラス名] ボックスの一覧を使用して DTEEvents を選択し、[メソッド名] ボックスの一覧を使用して OnMacrosRuntimeReset および OnStartupComplete を選択します。

これにより、これら 2 つのイベントに対してイベントハンドラーが作成されます。これらのイベントハンドラーは、Visual Studio IDE でイベントが発生するたびに ReferencesEvents ハンドラーがそのイベントを自動的に受け取るために必要です。

次に示すように、EnvironmentEvents.refEvents キャストを追加して、イベントハンドラーを変更します。参照が Visual Basic プロジェクトに追加されたときにイベントを受け取るには、CSharpReferencesEvents という文字列を VBReferencesEvents に置き換えます。

Public Sub DTEEvents_OnMacrosRuntimeReset() Handles_
 DTEEvents.OnMacrosRuntimeReset
        EnvironmentEvents.refEvents_
        =CType(DTE.Events.GetObject("CSharpReferencesEvents")_
        , ReferencesEvents)
End Sub

および

Private Sub DTEEvents_OnStartupComplete() Handles_
 DTEEvents.OnStartupComplete
        EnvironmentEvents.refEvents_
        = CType(DTE.Events.GetObject("CSharpReferencesEvents")_
        , ReferencesEvents)
End Sub

最後に、次のコードを EnvironmentEvents モジュールに貼り付けるか、[クラス名] ボックスの一覧の [refEvents] および [メソッド名] ボックスの一覧の [ReferenceAdded] を選択して、イベントハンドラーを作成します。次に示すように、イベントハンドラーに MsgBox(pReference.Name & " was added to the project.") 行を追加します。
```
Public Sub refEvents_ReferenceAdded(ByVal pReference As VSLangProj.Reference) Handles refEvents.ReferenceAdded
        MsgBox(pReference.Name & " was added to the project.")
End Sub
```
イベントハンドラーをテストするには、任意の種類の新しい Visual C# プロジェクトを作成します。

プロジェクトテンプレートに自動的に追加される参照ごとに、メッセージボックスが表示されます。

使用例

このコードでは、完全な例を示します。次のコードをマクロプロジェクトの EnvironmentEvents モジュールに貼り付けることができます。

注意

このイベントハンドラーを追加すると、指定したプロジェクトの種類に参照が追加されるたびにこのイベントハンドラーが発生します。参照が追加されるたびに発生するのを回避するには、このコードをコメントアウトします。

<System.ContextStaticAttribute()> Public WithEvents refEvents As VSLangProj.ReferencesEvents
Public Sub DTEEvents_OnMacrosRuntimeReset() Handles_
 DTEEvents.OnMacrosRuntimeReset
        EnvironmentEvents.refEvents= _
        CType(DTE.Events.GetObject("CSharpReferencesEvents")_
        , VSLangProj.ReferencesEvents)
End Sub
Private Sub DTEEvents_OnStartupComplete() Handles_
 DTEEvents.OnStartupComplete
        EnvironmentEvents.refEvents = _
        CType(DTE.Events.GetObject("CSharpReferencesEvents")_
        , VSLangProj.ReferencesEvents)
End Sub
Public Sub refEvents_ReferenceAdded(ByVal pReference As VSLangProj.Reference) Handles refEvents.ReferenceAdded
        MsgBox(pReference.Name & " was added to the project.")
End Sub