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

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

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

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

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

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

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

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 プロジェクトまたは Visual J# プロジェクトに追加した場合にイベントを受け取るには、CSharpReferencesEvents という文字列を、それぞれ VBReferencesEvents または VJSharpReferencesEvents で置き換えます。

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