Before Editor Context Menu

  • Configuration description
  • Pre-context menu object model objects
  • Popup menu behavior in CimView

Configuration description

Before Editor Context Menu allows an event to be fired right before a Popup menu opens in CimEdit.

Note: Global configuration allows the event to be handled by a global script on CimEdit screens that do not have the event already configured.
Field Description
A Action Contains a drop-down list of existing procedures and scripts. Use either of the following.
Procedure    
Script    
B Parameter Can be used if the event invokes a script directly or through a procedure. The default code begins as follows. Sub OnPreContextMenu(oContextMenu As GefContextMenu) ' Where parameters are:
oContextMenu  
C Debounce event Check      
Clear      
Note: When debouncing is enabled, the event/action queue is always processed one action at a time; the current action must be completed before the next action can start.
This makes the queue's event/action sequencing predictable and avoids situations where many events could trigger actions and consume unacceptable levels of CPU and memory.
     

Pre-context menu object model objects

CIMPLICITY includes object model objects for manipulating the context menu that will be displayed.

  • Objects include:

GefContextMenu (object)

GefContextMenuItem (object)

GefContextMenuItems (object)

  • The GefScreen object also includes the following property.

GefScreen.ContextMenuEnabled (property) (disables the context menu for the screen)

Popup menu behavior in CimEdit

  • Default

A screen designer can click the right-mouse button on any object to open a default Popup menu.

Exceptions include:

  • If the GefScreen object has been used in a script to disable the context menu, the Popup menu will not open; no further actions are taken.
  • (In CIMPLICITY version 7.0.00 and higher) if the role of the logged in user.

Does not allow a context menu the Popup menu will not open and no further actions are taken.

Does not allow point targets, Point Control Panel and Quick Trends do not display on the menu.

  • Before Editor Context Menu event and its configured script are used

A screen designer can click the right-mouse button on any object on a CimEdit screen to open a customized Popup menu that displays actionable items specified in your script configuration.

Exceptions include:

  • If the GefScreen object has been used in a script to disable the context menu, the Popup menu will not open; no further actions are taken.
  • If the Before Editor Context Menu script sets the GefContextMenu.Displayable (property) to false, the Popup menu will not open based on that event call.
  • (In CIMPLICITY version 7.0.00 and higher) if the user role

Does not allow a context menu, the Popup menu will not open and no further actions are taken.

Does not allow point targets, but the Before Editor Context Menu script explicitly adds them, the Point Control Panel and/or Quick Trends will display; in the menu when that instance of the menu is called..