asposediagram.api

asposediagram.api

Class EventItem

Encapsulates an event code. An EventItem element can trigger two kinds of actions: it can run an add-on, or it can send a notification of the event to the calling program.

Constructor Summary
EventItem()
Constructor.
 
Property Getters/Setters Summary
methodgetAction()
method
setAction(value)
           Specifies the action code of the parent EventItem element.For an EventItem element to be saved in a DatadiagramML file, it must be persistable. Currently, the only valid action code a persistable event can have is 1 (ONEVENT_ACT_RUNADDON).
methodgetEnabled()
method
setEnabled(value)
           Represents a flag indicating if the event is enabled or disabled. The value of the property is BOOL integer constant.
methodgetEventCode()
method
setEventCode(value)
           A code indicating the event that triggers the add-on. For more information on event codes, see Event Codes in the Microsoft Visio 2007 Automation Reference.
methodgetID()
method
setID(value)
           The ID of the event.
methodgetTarget()
method
setTarget(value)
           Specifies the target of an event.
methodgetTargetArgs()
method
setTargetArgs(value)
           Specifies a string containing arguments to be sent to the target of an event.
 

    • Constructor Detail

      • EventItem

        EventItem()
        Constructor.

    • Property Getters/Setters Detail

      • getID/setID : int 

        int getID() / setID(value)
        The ID of the event.

      • getAction/setAction : int 

        int getAction() / setAction(value)
        Specifies the action code of the parent EventItem element.For an EventItem element to be saved in a DatadiagramML file, it must be persistable. Currently, the only valid action code a persistable event can have is 1 (ONEVENT_ACT_RUNADDON).

      • getEventCode/setEventCode : int 

        int getEventCode() / setEventCode(value)
        A code indicating the event that triggers the add-on. For more information on event codes, see Event Codes in the Microsoft Visio 2007 Automation Reference.

      • getTarget/setTarget : String 

        String getTarget() / setTarget(value)
        Specifies the target of an event.

      • getTargetArgs/setTargetArgs : String 

        String getTargetArgs() / setTargetArgs(value)
        Specifies a string containing arguments to be sent to the target of an event.

      • getEnabled/setEnabled : int 

        int getEnabled() / setEnabled(value)
        Represents a flag indicating if the event is enabled or disabled. The value of the property is BOOL integer constant.