sapgui_grid_is_checkbox_selected

Grid Functions

Returns whether box is checked.

int sapgui_grid_is_checkbox_selected( const char *description, const char *gridID, const char *row, const char *column, [args,] LAST );
description User entered text to aid in understanding script
gridIDObject ID Strings
row Grid row number. The first data row is numbered zero (0). If there is a header row it is numbered (-1).
column Column number
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

The sapgui_grid_is_checkbox_selected data retrieval function returns true if the checkbox is selected or false if the box is cleared.

Return Values

This function returns True (-1) or False (0).

Parameterization

You can parameterize all string (char type) arguments.

Example

The following example uses sapgui_grid_is_checkbox_selected to check the state of a box before selecting it.

if (!sapgui_grid_is_checkbox_selected("Is box not set?",
        "usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "0", 
        "CONNID",
        BEGIN_OPTIONAL, 
            "AdditionalInfo=sapgui1019", 
        END_OPTIONAL)
            sapgui_grid_set_checkbox("Set box",
            "usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
                "0", 
                "CONNID",
                "True",
                BEGIN_OPTIONAL, 
                   "AdditionalInfo=sapgui1019", 
                END_OPTIONAL);