EventList.Add-Methode (Visio)
Fügt ein Event-Objekt hinzu, das ein Add-On ausführt, wenn ein Ereignis auftritt. Das Event-Objekt wird der EventList-Auflistung des Quellobjekts hinzugefügt, dessen Ereignisse Sie empfangen möchten.
Syntax
Ausdruck. Hinzufügen (EventCode, Action, Target, TargetArgs)
Ausdruck Eine Variable, die ein EventList-Objekt darstellt.
Parameter
Name | Erforderlich/Optional | Datentyp | Beschreibung |
---|---|---|---|
EventCode | Erforderlich | Integer | Das/die aufzuzeichnende(n) Ereignis(se). |
Aktion | Erforderlich | Integer | Die auszuführende Aktion. Muss visActCodeRunAddon sein, ein Element von VisEventCodes in der Visio-Typbibliothek. |
Target | Erforderlich | String | Der Name des Add-Ons. |
TargetArgs | Erforderlich | String | Die Zeichenfolge, die an das Event-Objekt übergeben wird, um dessen TargetArgs-Eigenschaft festzulegen. |
Rückgabewert
Ereignis
Hinweise
Das Quellobjekt, dessen EventList-Auflistung das Event-Objekt enthält, richtet den Bereich ein, in dem die Ereignisse gemeldet werden. Ereignisse werden für das Quellobjekt und untergeordnete Objekte in der Objektmodellhierarchie gemeldet. Um z. B. ein Add-On auszuführen, wenn ein bestimmtes Dokument geöffnet wird, fügen Sie einer EventList-Auflistung dieses Dokuments ein Event-Objekt für das DocumentOpened-Ereignis hinzu. Um ein Add-On auszuführen, wenn ein beliebiges Dokument in einer Instanz der Anwendung geöffnet wird, fügen Sie der EventList-Auflistung des Application-Objekts das Event-Objekt hinzu.
Das Erstellen von Event-Objekten ist eine gängige Methode, um Ereignisse aus C++ oder anderen als Microsoft Visual Basic-Lösungen zu behandeln. Wenn Sie die Visual Basic WithEvents-Schlüsselwort (keyword) verwenden, um Ereignisse zu behandeln, werden alle Ereignisse im Ereignissatz eines Quellobjekts ausgelöst. Wenn Sie jedoch Event-Objekte erstellen, wird Ihr Programm nur über die von Ihnen ausgewählten Ereignisse benachrichtigt. Je nach Lösung kann dies zu einer Leistungsverbesserung führen.
Event-Objekte, die Add-Ons ausführen, können permanent sein, d. h., sie können mit einem Visio-Dokument gespeichert werden. Die Eigenschaften Persistent und Persistable eines Event-Objekts müssen True sein, damit das Objekt permanent ist.
Mit den Argumenten, die an die Add-Methode übergeben werden, werden die Ausgangswerte für die Eigenschaften Event, Action (visActCodeRunAddon), Target und TargetArgs des Event-Objekts festgelegt.
Ereigniscodes werden von der Visio-Typbibliothek deklariert und erhalten das Präfix visEvt. Ereigniscodes stellen häufig eine Kombination von Konstanten dar. Beispielsweise ist visEvtAdd + visEvtDoc der Ereigniscode für das DocumentAdded-Ereignis . Informationen zum Suchen eines Ereigniscodes für das Ereignis, das Sie erstellen möchten, finden Sie unter Ereigniscodes.
Informationen zum Erstellen eines Event-Objekts, mit dem das Empfängerobjekt des Aufrufers über ein Ereignis informiert wird, finden Sie im Abschnitt zur AddAdvise-Methode.
Beispiel
Mit dem folgenden Beispiel wird gezeigt, wie der EventList-Auflistung des Quellobjekts ein Event-Objekt hinzugefügt wird, das ein Add-On ausführt. In diesem Fall ist es ein Document-Objekt, dessen Ereignisse Sie empfangen möchten.
Ersetzen Sie vor dem Ausführen dieses Makrospfaddateiname \ durch einen gültigen Pfad und Dateinamen für ein ausführbares Add-On (EXE) in Ihrem Visio-Projekt. Das Add-On sollte keine Argumente annehmen.
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
Support und Feedback
Haben Sie Fragen oder Feedback zu Office VBA oder zu dieser Dokumentation? Unter Office VBA-Support und Feedback finden Sie Hilfestellung zu den Möglichkeiten, wie Sie Support erhalten und Feedback abgeben können.