Share this page

# sapgui_grid_select_cell

Grid Functions

Selects one cell in grid.

    int sapgui_grid_select_cell( 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_select_cell selects a single cell in a grid control.

## 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_select_cell to select a cell.

Copy code

    // Put the Grid ID in a variable
    lr_save_string
        ("usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
        "GridID");

    //Select header (row -1) of Column 2
    sapgui_grid_select_cell("'Overview' (-1, Connection number)",
            "{GridID}", // Grid ID
            "-1", // Row number
            "CONNID", // Column ID
            BEGIN_OPTIONAL,
                "AdditionalInfo=sapgui1017",
            END_OPTIONAL);

    sapgui_grid_get_current_cell_column("Get Column",
            "{GridID}",
            "CurrentCellColumn", LAST );

    sapgui_grid_get_current_cell_row("Current Row",
            "{GridID}",
            "CurrentCellRow", LAST );

    sapgui_grid_get_cell_data("CellData",
            "{GridID}",
            "{CurrentCellRow}",
            "{CurrentCellColumn}",
            "CurrentCellData",
            LAST );

    // Output: "Current Cell Row: '-1', Column: 'CONNID', Data: 'No.'"
    lr_output_message("Current Cell Row: '%s', Column: '%s', Data: '%s'",
            lr_eval_string("{CurrentCellRow}"),
            lr_eval_string("{CurrentCellColumn}"),
            lr_eval_string("{CurrentCellData}"));

    // Select cell in first data row in column
    sapgui_grid_select_cell("'Overview' (-1, Connection number)",
            "usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
            "0", "CONNID", LAST );

    sapgui_grid_get_current_cell_column("Get Column",
            "{GridID}", "CurrentCellColumn", LAST );

    sapgui_grid_get_current_cell_row("Current Row",
            "{GridID}", "CurrentCellRow", LAST );

    sapgui_grid_get_cell_data("CellData",
            "{GridID}", "{CurrentCellRow}", "{CurrentCellColumn}",
            "CurrentCellData", LAST );

    // Output: "Current Cell Row: '0', Column: 'CONNID', Data: '17'"
    lr_output_message("Current Cell Row: '%s', Column: '%s', Data: '%s'",
            lr_eval_string("{CurrentCellRow}"),
            lr_eval_string("{CurrentCellColumn}"),
            lr_eval_string("{CurrentCellData}"));

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: