dlgEvent_record_OnActionStatesChange

Function called to make action state changes at the record level.

Syntax

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

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

Usage

When you select the On Action States Update (Record) property for the creation of the event, a function shell is created. Enter your code in the function.

Use this function to set the action state for default actions and defined actions. Use the uiMode parameter in an IF or CASE statement to set the state of an action based on the mode of the current dialog.

Example: record On Action States Change

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

In this example, the print_list action defined for the form, is set depending on the state of uiMode.

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

    DISPLAY "dlgEvent_recAccount_OnActionStatesChange (Record scope) is raised"
    # This sample code may be written instead in a function that
                    you call. 
    # The function would be in a module shared by forms and
                    applications, and imported using the IMPORT FGL statement.
    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

END FUNCTION