Form dialog functions

The BAM generates functions for working with form dialog code events.

Table 1. Form dialog events
Function Name Description
PUBLIC FUNCTION dlgEvent_OnOpenForm( 
   currentForm ui.FORM )
Function called on open form event.
PUBLIC FUNCTION dlgEvent_OnActionAccept( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called to overwrite a predefined action to accept the current interactive instruction.
PUBLIC FUNCTION dlgEvent_OnActionCancel( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called to overwrite a predefined action to cancel the current interactive instruction.
PUBLIC FUNCTION dlgEvent_OnActionClose( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called to overwrite a predefined action to close the current interactive instruction.
PUBLIC FUNCTION dlgEvent_OnActionExit( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called to overwrite a predefined action to exit the current interactive instruction.
PUBLIC FUNCTION dlgEvent_OnActionNew( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called to overwrite a predefined action to insert a new row in the current dialog.
PUBLIC FUNCTION dlgEvent_OnActionQuery( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called to overwrite a predefined action to query a dialog.
PUBLIC FUNCTION dlgEvent_OnActionStatesChange( 
   dlg ui.DIALOG, 
   uiMode SMALLINT )
Function called to make action state change at the form level.
PUBLIC FUNCTION dlgEvent_Before_SearchDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called before user searches a dialog at the form level.
PUBLIC FUNCTION dlgEvent_After_SearchDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   whereClause STRING, 
   detailList STRING)
   RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING, STRING)
Function called after the user has entered criteria for a search at the form level.
PUBLIC FUNCTION dlgEvent_Before_EmptyDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called when a form is opened without data (empty).
PUBLIC FUNCTION dlgEvent_Before_BrowseDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type,
   nextField STRING )
  RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING)
Function called before user browses a dialog at the form level.
PUBLIC FUNCTION dlgEvent_After_BrowseDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction DlgCtrlInstruction_Type)
  RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called after user browses a dialog at the form level.
PUBLIC FUNCTION dlgEvent_Before_EditDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type,
   nextField STRING )
  RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING)
Function called before user edits a dialog at the form level.
PUBLIC FUNCTION dlgEvent_After_EditDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
  RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
Function called after user edits a dialog at the form level.