EventList.Add メソッド (Visio)
イベントが発生したときにアドオンを実行する Event オブジェクトを追加します。 Event オブジェクトは、イベントを受信するソース オブジェクトの EventList コレクションに追加されます。
構文
式。追加 (EventCode、 Action、 Target、 TargetArgs)
式EventList オブジェクトを表す変数。
パラメーター
| 名前 | 必須 / オプション | データ型 | 説明 |
|---|---|---|---|
| EventCode | 必須 | Integer | キャプチャするイベントです。 |
| 操作 | 必須 | Integer | 実行するアクションです。 visActCodeRunAddon (Visio タイプ ライブラリの VisEventCodes のメンバー) でなければなりません。 |
| Target | 必須 | String | 使用するアドオンの名前です。 |
| TargetArgs | 必須 | String | TargetArgs プロパティを設定するために Event オブジェクトに渡される文字列。 |
戻り値
イベント
注釈
Event オブジェクトを含む EventList コレクションのソース オブジェクトは、イベントの報告対象のスコープを確立します。 イベントは、ソース オブジェクトと、オブジェクト モデルの階層に含まれる下位のオブジェクトに報告されます。 たとえば、特定の図面を開いたときにアドオンを実行するには、その図面の EventList コレクションに、DocumentOpened イベントの Event オブジェクトを追加します。 アプリケーションのインスタンスで画面を開いたときにアドオンを実行するには、Application オブジェクトの EventList コレクションに、Event オブジェクトを追加します。
Event オブジェクトの作成は、C++ または Microsoft Visual Basic 以外の他のソリューションからのイベントを処理する共通の方法です。 Visual Basic WithEvents キーワードを使用してイベントを処理すると、ソース オブジェクトのイベント セット内のすべてのイベントが発生しますが、 Event オブジェクトを作成すると、選択したイベントのみがプログラムに通知されます。 ソリューションによっては、この方法によりパフォーマンスが向上する可能性があります。
アドオンを実行する Event オブジェクトは永続的なものであり、Visio 図面と共に格納することができます。 永続的なオブジェクトにするためには、Event オブジェクトの Persistent プロパティと Persistable プロパティを両方とも True に設定する必要があります。
Add メソッドに渡す引数には、Event オブジェクトの Event プロパティ、Action (visActCodeRunAddon) プロパティ、Target プロパティ、および TargetArgs プロパティの初期値を設定します。
イベント コードは Visio タイプ ライブラリで宣言されており、プレフィックスは visEvt です。 多くのイベント コードは定数の組み合わせで構成されます。 たとえば、 visEvtAdd + visEvtDoc は DocumentAdded イベントのイベント コードです。 作成するイベントのイベント コードについては、「イベント コード」を参照してください。
呼び出し側のシンク オブジェクトにイベントを通知する Event オブジェクトを作成する方法については、「AddAdvise メソッド」を参照してください。
例
次の例は、アドオンを実行する Event オブジェクトをソース オブジェクト (受け取りたいイベントを含むオブジェクト。この例では Document オブジェクト) の EventList コレクションに追加する方法を示します。
このマクロを実行する前に、 パス \ ファイル名 を Visio プロジェクトの実行可能アドオン (EXE) の有効なパスとファイル名に置き換えます。 アドオンに渡す引数は不要です。
Public Sub AddEvent_Example()
Dim vsoAddons As Visio.Addons
Dim vsoEventList As Visio.EventList
Dim vsoDocument As Visio.Document
Dim vsoEvent As Visio.Event
Dim vsoAddon As Visio.Addon
'Add a document based on the Basic Diagram template.
Set vsoDocument = Documents.Add("Basic Diagram.vst")
'Add an add-on to the Addons collection.
Set vsoAddons = Visio.Addons
Set vsoAddon = vsoAddons.Add("path \filename ")
'Add a BeforeDeleteSelection event to the EventList collection
'of the Document object. The event will start your add-on,
'which takes no arguments.
Set vsoEventList = vsoDocument.EventList
Set vsoEvent = vsoEventList.Add(visEvtCodeBefSelDel, _
visActCodeRunAddon, _
"path \filename ", "")
End Sub
サポートとフィードバック
Office VBA またはこの説明書に関するご質問やフィードバックがありますか？ サポートの受け方およびフィードバックをお寄せいただく方法のガイダンスについては、Office VBA のサポートおよびフィードバックを参照してください。