📚 SAP Business One SDK Help

Add Method
See Also 
EventType
The event type to filter in

Description

Adds an EventFilter to the collection. 

Each EventFilter object holds an event type that will be listened for. The object can also specify form types, so only the event type in these forms is listened for.

Syntax

Visual Basic
Public Function Add( _
   ByVal EventType As BoEventTypes _
) As EventFilter

Parameters

EventType
ValueDescription
et_ALL_EVENTSAll events, for use when filtering events
et_ITEM_PRESSEDThe main mouse button was clicked on one of the following:
  • Tab
  • Button
  • Option button
  • Check box (standalone or within a cell)

This event occurs when a mouse is released within an item, that is, mouse up.

et_KEY_DOWNA key was pressed.
et_GOT_FOCUSAn item received focus.
et_LOST_FOCUSAn item lost focus.
et_COMBO_SELECTA value was selected in a combo box.
et_CLICKThe main mouse button was clicked on an item, that is, mouse down.
et_DOUBLE_CLICKThe main mouse button was double-clicked on an item.
et_MATRIX_LINK_PRESSEDA link arrow in a matrix was pressed.
et_MATRIX_COLLAPSE_PRESSEDA matrix list was collapsed or expanded.
et_VALIDATEAn item lost focus and validation is required.
et_MATRIX_LOADData was loaded from the database into a matrix data source.

This event occurs for user-defined matrix objects only. If a form contains two matrix objects, the system generates two events.

et_DATASOURCE_LOADData was loaded from the GUI into a matrix data source.

This event occurs once per matrix. If a form has two matrix objects, the system generates two events.

et_FORM_LOADA form was opened (FormDataEvent).
et_FORM_UNLOADA form was closed.
et_FORM_ACTIVATEA form received focus.
et_FORM_DEACTIVATEA form lost focus.
et_FORM_CLOSEA form is about to be closed.
et_FORM_RESIZEA form has been resized.
et_FORM_KEY_DOWNA key was pressed when no form had the focus.
et_FORM_MENU_HILIGHTA form is modifying the status of toolbar items, that is, enabling and disabling icons.

By default, these events are not thrown. You can activate these events by setting an event filter.

et_PRINTA print preview was requested for a report or document (PrintEvent).

This event lets you exit from the application print operation and use your own printing.

et_PRINT_DATAA print preview was requested for a report (ReportDataEvent). 

This event lets you get the report data in XML format.

et_CHOOSE_FROM_LISTChooseFromList event occurred, as follows: 
  • The Before event occurs before the ChooseFromList form is displayed. If the BubbleEvent parameter is set to False, the form is not displayed.
  • The After event occurs after the user makes a selection or chooses Cancel.
et_RIGHT_CLICKThe right mouse button was clicked on an item (RightClickEvent).
et_MENU_CLICKThe main mouse button was released on a menu item without submenus.

For future use.

et_FORM_DATA_ADDA record in a business object was added (FormDataEvent).
et_FORM_DATA_UPDATEA record in a business object was updated (FormDataEvent).
et_FORM_DATA_DELETEA record in a business object was deleted (FormDataEvent).
et_FORM_DATA_LOADA record in a business object was loaded -- via browse, link button, or find (FormDataEvent).
et_PICKER_CLICKEDPicker event occurred, as follows: 
  • The Before event occurs before the Picker form is displayed. If the BubbleEvent parameter is set to False, the picker is not displayed.
  • The After event occurs after the user makes a selection or chooses Cancel.
et_GRID_SORTA grid column was sorted, either by a user clicking the column title or an add-on calling the Sort method of the Grid object.
et_DragThe item was dragged and dropped at the position you want it to appear.
et_FORM_DRAWA form was drawn (ItemEvent).

The before event would raise after the FormLoadAfter event and before the form was drawn.
And after the form was drawn, which means all form items location/size is determined (for system form), the after form draw event would be raised.

et_UDO_FORM_BUILDA UDO form was built.
et_UDO_FORM_OPENA UDO form was opened.
et_B1I_SERVICE_COMPLETEThe B1i service has been completed.
et_FORMAT_SEARCH_COMPLETEDThe format search has been completed.
et_PRINT_LAYOUT_KEYA print or print preview was requested for an add-on form, and the layout needs the key of the add-on form (LayoutKeyEvent).
et_FORM_VISIBLEA form was visible.
et_ITEM_WEBMESSAGEA Web message was sent from the WebBrowser control.
The event type to filter in

Remarks

For more information, see Filtering Events.

See Also