dlgEvent_After_SearchDialog

Function called after the user has entered criteria for a search at the form level.

Syntax

PUBLIC FUNCTION dlgEvent_After_SearchDialog( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   whereClause STRING, 
   detailList STRING)
   RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING, STRING)

The function parameters are:

dlg. This is a ui.DIALOG object referencing the current dialog. The dialog can implement an INPUT, INPUT ARRAY, DISPLAY ARRAY, MENU, or CONSTRUCT. For more information, see The Dialog class in Genero Business Development Language User Guide.

uiMode. This is an integer value defining the current mode or state in relation to user action in the dialog, form, or application. Modes are defined as constants in the libdbappFormUI file in the libdbapp library.

Table 1. UI modes
Description	Applies to ...	Constant	Value
Display	`DISPLAY ARRAY`	C_MODE_DISPLAY	1
Modify	`INPUT \ INPUT ARRAY`	C_MODE_MODIFY	2
Add	`INPUT \ INPUT ARRAY`	C_MODE_ADD	3
Search	`CONSTRUCT`	C_MODE_SEARCH	4
Empty	`MENU`	C_MODE_EMPTY	5
Exit form	The form	C_MODE_EXIT_FORM	6
Exit app	The app	C_MODE_EXIT_APP	7
Undefined	All (array, form, or app)	C_MODE_UNDEFINED	0

whereClause is a string containing the WHERE clause in an SQL search.
detailList is a string with the list of fields (details) on which a search is to be done.

The function returns values are:

dlgCtrlInstruction is a libdbappEvents.DlgCtrlInstruction_Type defining the dialog control instruction. Instructions available in the function are shown in the table.
Table 2. Dialog control instructions

Description Constant Value

Continue dialog CONTINUE_DIALOG 2

Exit dialog EXIT_DIALOG 3
whereClause is a string containing the WHERE clause in an SQL search.
detailList is a string with the list of fields (details) on which a search is to be done.

Table 2. Dialog control instructions
Description	Constant	Value
Continue dialog	`CONTINUE_DIALOG`	2
Exit dialog	`EXIT_DIALOG`	3

Usage

When you select the After Search Dialog property for the creation of the event, a function shell is created. Enter your code in the function.

This function is called when a user has entered criteria for a search. You code to query the input buffers of the fields to get the values entered and to validate all the required search fields.

Example: form After Search Dialog

This example uses the After Search Dialog code event for the Account form in the OfficeStore demo.

The function checks the input buffers of the specified fields. If nothing was entered for these fields, a message is displayed and the focus returns to the dialog.

PUBLIC FUNCTION dlgEvent_After_SearchDialog(dlg ui.DIALOG, uiMode SMALLINT, 
     dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type, whereClause STRING, detailList STRING)
    RETURNS (libdbappEvents.DlgCtrlInstruction_Type, STRING, STRING)

    DISPLAY "dlgEvent_After_SearchDialog (Form scope) is raised"

    IF length(dlg.getFieldBuffer("account.lastname")) == 0
        OR length(dlg.getFieldBuffer("account.email")) == 0 THEN
        ERROR "Enter a search criteria for customer name and email address fields."
        LET dlgCtrlInstruction = libdbappEvents.CONTINUE_DIALOG
    END IF
    DISPLAY "dlgEvent_After_SearchDialog (Form scope) is exited"

    RETURN dlgCtrlInstruction, whereClause, detailList
END FUNCTION