Share this page

# sapgui_grid_click

Grid Functions

Clicks on a cell in a grid.

    int sapgui_grid_click( const char *description, const char *gridID, const char *row, const char *column, [args,] LAST );

description | User entered text to aid in understanding script
gridID | Object 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 | Grid column identifier. The column identifier string is inserted in the script during recording. This string is the field name defined in the SAP data dictionary. This identifier cannot be replaced with a column number.
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_click emulates a user clicking on a the cell in a grid by "row" and "column".

## Return Values

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure.

## Parameterization

You can parameterize all string (char type) arguments.

## Example

The following example uses sapgui_grid_click to set the input focus on the first row, column "STATUSSICON".

Copy code

    // Save the Grid ID in variable "GridID"
    lr_save_string(
        "usr/subSUB0:SAPLMEGUI:0013/subSUB2:SAPLMEVIEWS:1100/subSUB2:SAPLMEVIEWS:1200/subSUB1:SAPLMEGUI:3212/cntlGRIDCONTROL/shellcont/shell",
           "GridID");

    sapgui_grid_click
       ("Select Row one, status column", //Any text
        "{GridID}",               // Grid ID
        "0",                         // First Row
        "STATUSICON",    // Column
        BEGIN_OPTIONAL,
            "AdditionalInfo=info1041",
        END_OPTIONAL);

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: