Event property

Microsoft Visio Developer Reference

Event property

   Example   

Gets or sets the event code of an Event object—an event-action pair. When the event occurs, the action is performed.

Version added

4.0

Syntax

intRet = object.Event
object.Event = eventCode

intRet

Integer. The current event code.

object

Required. An expression that returns an Event object.

eventCode

Required Integer. The new event code.

Remarks

If the action code of the Event object is visActCodeRunAddon, the event also specifies the target of the action and the arguments to send to the target. This information is stored in the Target and TargetArgs properties, respectively.

If the action code of the Event object is visActCodeAdvise, the event also specifies the object to receive event notifications (sometimes called the sink object) and arguments to send to the sink object along with the notification.

Event codes are declared by the Visio type library. They are prefixed with "visEvt" and are listed in event topics in this Automation Reference. For a list of event codes, see Event codes.

A program can use the Trigger method to cause an Event object's action to be performed without waiting for the event to occur.