Standard Events

The events listed here are standard events that apply to many different items. Items which have a standard event only include the event name in their event table - please use the entry here to read about the event.

evAfterSent to a field when there is a chance it will cease to be the target field.For the JavaScript client,the data must also have changed
pEventCodeThe event code
pNextCodeThe event code to follow the evAfter
pClickedFieldA reference to the field which was clicked
pClickedWindowA reference to the field or window which was clicked
pMenuLineA reference to the menu line which was selected
pCommandNumberThe Omnis command number selected from a built-in menu
pRowA reference to the list row
evBeforeSent to a field when it becomes the target field
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
evCanDropSent to a field to test whether it can accept a drop
pEventCodeThe event code
pDragTypeThe type of data being dragged (one of the kDrag... constants)
pDragValueThe value being dragged
pDragFieldThe field being dragged. Either an item reference or for the JavaScript client the object name
pDropIdThe identifier of the area of the control over which the drop is to occur.Either a line number or ident (when $hiliteline is true),or zero if the control is not list-based (or $hiliteline is false)
pDropRowThe row of the complex grid on which the drop is to occur. Zero if the control does not belong to a complex grid
pColNumThe column of the data grid on which the drop is to occur. Zero if the control is not a data grid
evClickNotification of a click on a button or field
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
pTimeoutIf true,evClick is being sent to a push button for which $timeout has expired
pSystemKeyThe system key pressed. If evClick or evDoubleClick list events this parameter may be set to the key changing the row eg. kUp or kDown
evClipChangedDataSent to the field when the clipboard has changed the data ($contents)
pEventCodeThe event code
evDisabledSent to a field when it has been disabled
pEventCodeThe event code
evDoubleClickNotification of a double click on a button or field
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
pSystemKeyThe system key pressed. If evClick or evDoubleClick list events this parameter may be set to the key changing the row eg. kUp or kDown
evDragSent to a field when its contents are about to be dragged
pEventCodeThe event code
pDragTypeThe type of data being dragged (one of the kDrag... constants)
pDragValueThe value being dragged
evDragBorderThe user has possibly resized the field (and therefore other fields in the same parent) using the drag border
pEventCodeThe event code
evDragFinishedSent to the dragged field after a drag and drop operation has been completed or cancelled
pEventCodeThe event code
evDropSent to a field when a drop occurs
pEventCodeThe event code
pDragTypeThe type of data being dragged (one of the kDrag... constants)
pDragValueThe value being dragged
pDragFieldThe field being dragged. Either an item reference or for the JavaScript client the object name
pDropIdThe identifier of the area of the control over which the drop is to occur.Either a line number or ident (when $hiliteline is true),or zero if the control is not list-based (or $hiliteline is false)
pDropRowThe row of the complex grid on which the drop is to occur. Zero if the control does not belong to a complex grid
pColNumThe column of the data grid on which the drop is to occur. Zero if the control is not a data grid
evEnabledSent to a field when it has been enabled
pEventCodeThe event code
evExecuteContextMenuSent to a field or remote form when a context menu item is selected
pEventCodeThe event code
pCommandIDThe command ID of the selected remote menu item
pClickedFieldA reference to the field which was clicked
pPositionThe position of the menu within the control e.g. if the menu belongs to a tab,the tab number of the tab. Zero if position information is not relevant. (JavaScript client only)
pControlMenuIf true,the menu is a control menu. If false,it is a context menu. (JavaScript client only)
evHiddenSent to a field when it has been hidden
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evHScrolledSent to a field when it is scrolled horizontally
pEventCodeThe event code
evKeySent to the target field when a key is pressed
pEventCodeThe event code
pKeyThe key pressed
pSystemKeyThe system key pressed. If evClick or evDoubleClick list events this parameter may be set to the key changing the row eg. kUp or kDown
evMouseDoubleSent to a field when the left button is double clicked inside its border
pEventCodeThe event code
evMouseDownSent to a field when the left button is clicked inside its border
pEventCodeThe event code
pMouseXMouse x coordinate
pMouseYMouse y coordinate
pMouseHwndWindow identifier of the hwnd receiving the mouse event; the mouse coordinate parameters are relative to this hwnd
evMouseEnterSent to a field when the mouse enters its border
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
evMouseLeaveSent to a field when the mouse leaves its border
pEventCodeThe event code
pRowA reference to the list row
pLineNumberThe line number in the list
evMouseUpSent to a field when the left button is released
pEventCodeThe event code
pMouseXMouse x coordinate
pMouseYMouse y coordinate
pMouseHwndWindow identifier of the hwnd receiving the mouse event; the mouse coordinate parameters are relative to this hwnd
evOpenContextMenuSent to a field or a remote form or a window when a context menu is about to open
pEventCodeThe event code
pContextMenuA reference to the menu instance or remote menu instance that is about to pop up as a context menu
pClickedFieldA reference to the field which was clicked
pPositionThe position of the menu within the control e.g. if the menu belongs to a tab,the tab number of the tab. Zero if position information is not relevant. (JavaScript client only)
pTokenThe token (only relevant when using $tokenmenu for the token entry field)
pControlMenuIf true,the menu is a control menu. If false,it is a context menu. (JavaScript client only)
evRMouseDoubleSent to a field when the right button is double clicked inside its border
pEventCodeThe event code
evRMouseDownSent to a field when the right button is clicked inside its border
pEventCodeThe event code
pMouseXMouse x coordinate
pMouseYMouse y coordinate
pMouseHwndWindow identifier of the hwnd receiving the mouse event; the mouse coordinate parameters are relative to this hwnd
evRMouseUpSent to a field when the right button is released
pEventCodeThe event code
pMouseXMouse x coordinate
pMouseYMouse y coordinate
pMouseHwndWindow identifier of the hwnd receiving the mouse event; the mouse coordinate parameters are relative to this hwnd
evSentSent when a field value has changed due to a DDE or AppleEvent operation
pEventCodeThe event code
pChannelNumberThe DDE channel number (not relevant on macOS or Linux)
pDdeItemNameThe DDE data item name used to address the received value (not relevant on macOS or Linux)
pDdeValueThe new value received using DDE (not relevant on macOS or Linux)
evShiftTabSent to the target field when the shift-tab key is pressed
pEventCodeThe event code
evShownSent to a field when it has been made visible
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evTabSent to the target field when the tab key is pressed
pEventCodeThe event code
evVScrolledSent to a field when it is scrolled vertically
pEventCodeThe event code
evWillDropSent to a field before its contents are dropped on another field or window
pEventCodeThe event code
pDragTypeThe type of data being dragged (one of the kDrag... constants)
pDragValueThe value being dragged
pDropFieldThe field or window which is to receive the drop. Either an item reference or for the JavaScript client the object name
pDropIdThe identifier of the area of the control over which the drop is to occur.Either a line number or ident (when $hiliteline is true),or zero if the control is not list-based (or $hiliteline is false)
pDropRowThe row of the complex grid on which the drop is to occur. Zero if the control does not belong to a complex grid
pColNumThe column of the data grid on which the drop is to occur. Zero if the control is not a data grid