dlgEvent_OnActionCancel

Function called to overwrite a predefined action to cancel the current interactive instruction.

Syntax

PUBLIC FUNCTION dlgEvent_OnActionCancel( 
   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 Cancel 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 cancel the current interactive instruction.

Example: On Action Cancel

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

In this example, the function returns control to the dialog based on the user selection of yes or no in the mbox_yn dialog. This example uses a user-defined function to verify the action. This function would be in a module shared across forms and applications, and imported using the IMPORT FGL statement.

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

    DEFINE r INTEGER
    DISPLAY "dlgEvent_OnActionCancel (Form scope) is raised"
                   
    IF NOT myAccountFunc.mbox_yn("Accounts", "Are you sure you want to cancel?","question") THEN
        LET dlgCtrlInstruction = CONTINUE_DIALOG 
    END IF
   
    RETURN dlgCtrlInstruction
END FUNCTION