Available Events
In CimEdit, you use an event to trigger a procedure (which contains an action or series of actions). If you associate a specific event with more than one item on the screen, how the event triggers actions depends on the event.
Note: The following events are triggered in CimView only, except for:
Event | Triggered In |
---|---|
Object Inserted | CimEdit only |
Object Removed | CimEdit only |
Smart Object | CimEdit and CimView |
For | Event | Description | Screen* |
ActiveX Controls | |||
ActiveX Event | See the ActiveX control documentation for specific information for an ActiveX event. | ||
Dialog Box | |||
Dialog Close | A user closes a screen that was opened using the GefApplication. DialogPopup or GefScreens.DialogPopup method in the CimEdit/CimView Object Model. | Y | |
Expressions | |||
Expression High | The criteria are met for an item with the expression event, no matter what object is highlighted. | Y | |
Expression Update | |||
Events | |||
Before Context Menu | Allows an event to be fired right before a CimView Popup (context) menu opens. | Y | |
Before Editor Context Menu | Allows an event to be fired right before a CimEdit Popup (context) menu opens. | Y | |
Keystrokes | |||
Key Down | (For all associated items) whenever a selected key is pressed (down or up), no matter what item is highlighted. | Y | |
Key Up | |||
While Key Down | For all associated objects while the key is pressed and at the specified intervals, no matter what item is highlighted. | Y | |
Mouse buttons | |||
Highlight | When an object is highlighted or un-highlighted. | Y | |
Unhighlight | |||
Mouse Down | For the item the cursor is over when the left mouse button is pressed (down or up). | Y | |
Mouse Up | |||
While Mouse Down | (For selected item) while the left mouse button is down and at the specified intervals | Y | |
Periodic | |||
Periodic | (For all associated items) whenever the specified interval elapses, no matter what item is highlighted. | Y | |
Objects | |||
Object Inserted | (CimEdit only) for the associated SmartObject that is being inserted or removed. | ||
Object Removed | |||
SmartObject | (CimEdit and CimView) when the SmartObject is double-clicked, triggered from a CimEdit menu or from an associated popup menu. (A SmartObject event is configured the same way as any other event. | ||
Note: The Object Explorer contains several SmartObjects. In addition, a developer can create new SmartObjects and use the Smart Object, Object Inserted, or Object Removed events to trigger procedures specific to the design project. | |||
Screens | |||
Screen Close | When a user closes or opens the screen on which the event is configured. | Y | |
Screen Open | For all associated objects when the screen is open or closed. | Y |
*Screen: Y indicates that the event is available at the screen level configuration.