方法 : マクロで環境イベントを処理する

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

更新 : 2007 年 11 月

すべての新規マクロプロジェクトには、マクロ IDE でのみ表示される EnvironmentEvents という名前のモジュールが含まれます。このテンプレートアイテムには、役に立つ定義済みイベントプロシージャが含まれており、マクロの中で実装できます。含まれているプロシージャは次のとおりです。

これらのイベントプロシージャは [クラス名] ボックスに表示され、イベントは [メソッド名] ボックスに表示されます。どちらのボックスも、コードエディタの上部にあります。

定義済みのイベントプロシージャをマクロに追加するには

マクロ IDE の [クラスビュー] エクスプローラペインで、[EnvironmentEvents] ノードをダブルクリックし、マクロエディタペインの [EnvironmentEvents] タブおよびドロップダウンメニューとして表示します。
[EnvironmentEvents] ドロップダウンメニューで、イベントの種類 ([TaskListEvents] など) をクリックします。選択したイベントの種類で利用できるイベント (タスク一覧イベントなど) が、[宣言] ボックスに表示されます。
[宣言] ドロップダウンメニューでイベント ([TaskAdded] など) をクリックし、そのイベントプロシージャをモジュールに追加します。

マクロにイベントが挿入されて、イベントプロシージャにコードを追加できるようになります。

CommandEvents などのイベントでは、[クラス名] ボックスにイベントプロシージャを追加することが必要になる場合があります。

新しいイベントプロシージャの追加

[クラス名] ボックスに新しいイベントプロシージャを追加するには

"Automatically generated code, do not modify" というラベルの付いた EnvironmentEvents モジュールの非表示領域の後に、次のようにイベントの宣言を入力します。
```
<System.ContextStaticAttribute()> Public WithEvents CommandEvents As EnvDTE.CommandEvents
' This procedure handles DTEEvents.OnMacrosRuntimeReset.
```
マクロを実行し直すたびに新しいイベント変数を初期化するように、OnMacrosRuntimeReset プロシージャを設定します。
```
Public Sub DTEEvents_OnMacrosRuntimeReset() Handles _
  DTEEvents.OnMacrosRuntimeReset
   CommandEvents = DTE.Events.CommandEvents
End Sub
```

手順 2. の初期化プロシージャを完了する OnStartupComplete プロシージャを設定します。

Private Sub DTEEvents_OnStartupComplete() Handles_
  DTEEvents.OnStartupComplete
        CommandEvents = DTE.Events.CommandEvents
End Sub

イベントに応答するためのコードを追加します。この例では、コマンドを実行すると、発行されたコマンドについての詳細がこのプロシージャによってレポートされます。
```
Public Sub CommandEvents_AfterExecute(ByVal Guid As String, ByVal ID As Integer, ByVal CustomIn As Object, ByVal CustomOut as Object) Handles CommandEvents.AfterExecute
   MsgBox(DTE.Commands.Item(Guid, ID).Name)
End Sub
```

新しく宣言したイベントを使用するには、先にイベントを初期化する必要があります。マクロの場合、新しいイベント変数の初期化は、OnMacrosRuntimeReset イベントプロシージャの中で行います。

マクロが読み込まれたり、アンロードされたりした場合など、マクロのランタイムがリセットされたときは、常にこのイベントが発生します。このイベントが発生すると、グローバル状態が失われます。つまり、グローバル変数の値は失われ、イベントハンドラのフックは解除されて、イベントが発生したときに実行されていたコードは実行されなくなります。

マクロのランタイムがリセットされると、OnMacrosRuntimeReset イベントが発生します。このイベントを利用すると、マクロのランタイムがリセットされるたびに、変数とイベントハンドラを自動的に再初期化できます。OnMacrosRuntimeReset でイベントの変数とハンドラを初期化することにより、マクロのランタイムがリセットされるたびに変数とハンドラの値を確実に初期化し、新しいイベントプロシージャを正しく動作させることができます。