dlgEvent_OnActionQuery

Function called to overwrite a predefined action to query a dialog.

Syntax

PUBLIC FUNCTION dlgEvent_OnActionQuery( 
   dlg ui.DIALOG, 
   uiMode SMALLINT,
   dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
RETURNS (libdbappEvents.DlgCtrlInstruction_Type)
The function parameters are:
  1. 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.
  2. 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
  3. dlgCtrlInstruction is a libdbappEvents.DlgCtrlInstruction_Type defining the dialog control instruction.
    Instructions available will vary depending on the uiMode:
    • For display, modify, add, and search mode, see Table 2.
    • For empty mode, see Table 3.
    Table 2. Dialog control instructions for display/modify/add/search modes
    Description Constant Value
    Accept dialog ACCEPT_DIALOG 1
    Continue dialog CONTINUE_DIALOG 2
    Exit dialog EXIT_DIALOG 3
    Table 3. Dialog control instructions for empty mode
    Description Constant Value
    Continue menu CONTINUE_MENU 4
    Exit menu EXIT_DIALOG 5

The function returns a dialog control instruction value defined by libdbappEvents.DlgCtrlInstruction_Type.

Usage

When you select the On Action Query property for the creation of the event, a function shell is created. Enter your code in the function.

Use this function to overwrite a predefined action to query by example in DISPLAY ARRAY, INPUT [ARRAY], and MENU blocks (corresponds to the "DISPLAY", "MODIFY|ADD" and "EMPTY" UI modes).

Example: On Action Query

This example uses the On Action Query code event for a form in the OfficeStore demo.

In this example, EXIT_DIALOG is executed when the dialog is queried (dlgCtrlInstruction = libdbappEvents.EXIT_DIALOG). This overwrites the default behavior, which is to execute ACCEPT DIALOG in MODIFY mode and in ADD mode only if the dialog has been touched. This code is used to skip the validation of a field when you press the "Search" button.

PUBLIC FUNCTION dlgEvent_OnActionQuery(dlg ui.DIALOG, uiMode SMALLINT,
      dlgCtrlInstruction libdbappEvents.DlgCtrlInstruction_Type)
    RETURNS (libdbappEvents.DlgCtrlInstruction_Type)

    DISPLAY "dlgEvent_OnActionQuery (Form scope) is raised"
    LET dlgCtrlInstruction = libdbappEvents.EXIT_DIALOG

    RETURN dlgCtrlInstruction
END FUNCTION