EventList. Add-Methode (Visio)EventList.Add method (Visio)

Fügt ein Event -Objekt hinzu, das ein Add-on ausführt, wenn ein Ereignis auftritt.Adds an Event object that runs an add-on when an event occurs. Das Event -Objekt wird zur EventList -Auflistung des Source-Objekts hinzugefügt, dessen Ereignisse Sie empfangen möchten.The Event object is added to the EventList collection of the source object whose events you want to receive.

SyntaxSyntax

Ausdruck. Hinzufügen (EventCode, Action, target, TargetArgs)expression.Add (EventCode, Action, Target, TargetArgs)

Ausdruck Eine Variable, die ein EventList -Objekt darstellt.expression A variable that represents an EventList object.

ParameterParameters

NameName Erforderlich/OptionalRequired/Optional DatentypData type BeschreibungDescription
EventCodeEventCode ErforderlichRequired IntegerInteger Das/die aufzuzeichnende(n) Ereignis(se).The event(s) to capture.
ActionAction ErforderlichRequired IntegerInteger Die auszuführende Aktion.The action to perform. Muss visActCodeRunAddonsein, ein Mitglied von VisEventCodes in der Visio-Typbibliothek.Must be visActCodeRunAddon, a member of VisEventCodes in the Visio type Library.
TargetTarget ErforderlichRequired StringString Der Name des Add-Ons.The name of your add-on.
TargetArgsTargetArgs ErforderlichRequired StringString Die Zeichenfolge, die an das Event -Objekt übergeben wird, um die zugehörige TargetArgs -Eigenschaft festzulegen.The string that is passed to your Event object to set its TargetArgs property.

RückgabewertReturn value

EreignisEvent

BemerkungenRemarks

Das Source-Objekt **** , dessen EventList-Auflistung das Event -Objekt enthält, legt den Bereich fest, in dem die Ereignisse gemeldet werden.The source object whose EventList collection contains the Event object establishes the scope in which the events are reported. Ereignisse werden für das Quellobjekt und untergeordnete Objekte in der Objektmodellhierarchie gemeldet.Events are reported for the source object and objects lower in the object model hierarchy. 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.For example, to run an add-on when a particular document is opened, add an Event object for the DocumentOpened event to the EventList collection of that document. 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.To run an add-on when any document is opened in an instance of the application, add the Event object to the EventList collection of the Application object.

Das Erstellen von Event -Objekten ist eine gängige Methode zum Behandeln von Ereignissen aus C++ oder anderen nicht Microsoft Visual Basic-Lösungen.Creating Event objects is a common way to handle events from C++ or other non-Microsoft Visual Basic solutions. Wenn Sie das Visual Basic WithEvents -Schlüsselwort verwenden, um Ereignisse zu behandeln, werden alle Ereignisse im Ereignissatz eines Quellobjekts ausgelöst, aber wenn Sie Ereignis Objekte erstellen, wird Ihr Programm nur über die von Ihnen ausgewählten Ereignisse benachrichtigt.When you use the Visual Basic WithEvents keyword to handle events, all the events in a source object's event set fire, but when you create Event objects, your program will only be notified of the events you select. Je nach Lösung kann dies zu einer Leistungsverbesserung führen.Depending on your solution, this may result in improved performance.

Event-Objekte, die Add-Ons ausführen, können permanent sein, d. h., sie können mit einem Visio-Dokument gespeichert werden.Event objects that run add-ons can be persistent: that is, they can be stored with a Visio document. Die Eigenschaften Persistent und Persistable eines Event-Objekts müssen True sein, damit das Objekt permanent ist.To be persistent, an Event object's Persistent and Persistable properties must both be True.

Die an die Add -Methode übergebenen Argumente legen die Anfangswerte der Ereignis ****-, Action (visActCodeRunAddon)-, target-und TargetArgs -Eigenschaften des Ereignis Objekts fest.The arguments passed to the Add method set the initial values of the Event object's Event, Action (visActCodeRunAddon), Target, and TargetArgs properties.

Ereigniscodes werden von der Visio-Typbibliothek deklariert und weisen das Präfix visEvtauf.Event codes are declared by the Visio type library and have the prefix visEvt. Ereigniscodes stellen häufig eine Kombination von Konstanten dar.Event codes are often a combination of constants. VisEvtAdd + visEvtDoc ist beispielsweise der Ereigniscode für das DocumentAdded -Ereignis.For example, visEvtAdd + visEvtDoc is the event code for the DocumentAdded event. Informationen zum Suchen eines Ereigniscodes für das Ereignis, das Sie erstellen möchten, finden Sie unter Ereigniscodes.To find an event code for the event that you want to create, see Event Codes.

Informationen zum Erstellen eines Event -Objekts, das das Senke-Objekt des Anrufers über ein Ereignis berät, finden Sie unter der AddAdvise-Methode. ****To create an Event object that advises the caller's sink object about an event, see the AddAdvise method.

BeispielExample

Das folgende Beispiel zeigt, wie Sie ein Event -Objekt hinzufügen, mit dem ein Add **** -on zur EventList-Auflistung des Source-Objekts, in diesem Fall ein Document -Objekt, dessen Ereignisse Sie empfangen möchten, ausgeführt wird.The following example shows how to add an Event object that runs an add-on to the EventList collection of the source object, in this case a Document object, whose events you want to receive.

Ersetzen Sie vor dem Ausführen dieses Makros den Pfadnamen \ __ durch einen gültigen Pfad und Dateinamen für ein ausführbares Add-on (exe) in Ihrem Visio-Projekt.Before running this macro, replace path \ filename with a valid path and file name for an executable add-on (EXE) in your Visio project. Das Add-On sollte keine Argumente annehmen.The add-on should take no arguments.

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 FeedbackSupport and feedback

Haben Sie Fragen oder Feedback zu Office VBA oder zu dieser Dokumentation?Have questions or feedback about Office VBA or this documentation? Unter Office VBA-Support und Feedback finden Sie Hilfestellung zu den Möglichkeiten, wie Sie Support erhalten und Feedback abgeben können.Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.