dlgEvent_OnActionStatesChange

Function called to make action state change at the form level.

Syntax

PUBLIC FUNCTION dlgEvent_OnActionStatesChange( 
   dlg ui.DIALOG, 
   uiMode SMALLINT )

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

Usage

When you select the On Action States Update (Form) property for the creation of the event, a function shell is created.

This function is called to set the state for the actions you have defined. For example, if the uiMode parameter value is set to C_MODE_SEARCH when the event is triggered, you code to set the state of your actions to enable/disable, hide/visible according to the mode.

Example: form On Action States Change

This example uses the On Action States Update (Form) code event for a form in the OfficeStore demo.

In this example, the function enables or disables an action depending on the state of uiMode.

PUBLIC FUNCTION dlgEvent_OnActionStatesChange(dlg ui.DIALOG, uiMode SMALLINT)

    DISPLAY "dlgEvent_OnActionStatesChange (Form scope) is raised"
    DISPLAY "uiMode: ", uiMode
    CASE uiMode
        WHEN C_MODE_DISPLAY
            CALL dlg.setActionActive('print_list', TRUE)
            CALL dlg.setActionHidden('print_list', FALSE)
        WHEN C_MODE_MODIFY
            CALL dlg.setActionActive('print_list', FALSE)
            CALL dlg.setActionHidden('print_list', TRUE)
        WHEN C_MODE_ADD
            CALL dlg.setActionActive('print_list', FALSE)
            CALL dlg.setActionHidden('print_list', TRUE)
        WHEN C_MODE_SEARCH
            -- [...]
        WHEN C_MODE_EMPTY
            CALL dlg.setActionActive('print_list', FALSE)
            CALL dlg.setActionHidden('print_list', TRUE)
        OTHERWISE
            DISPLAY "unknown mode  ", uiMode
    END CASE
    DISPLAY "dlgEvent_OnActionStatesChange (Form scope) is exited"
END FUNCTION