sapgui_grid_select_rows

Grid Functions

Selects a row or rows in a grid

int sapgui_grid_select_rows( const char *description, const char *gridID, const char *rows, [args,] LAST );
description User entered text to aid in understanding script
gridIDObject ID Strings
rows A list of Row numbers separated by commas, or a range defined by two numbers and a hyphen, or a combination of these. The first data row is numbered zero (0). If there is a header row it is numbered (-1).
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_select_rows selects one or more rows 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_rows to select a single row, a list of rows, and a range of rows.

// Save the Grid ID in variable "GridID"
lr_save_string
    ("usr/cntlBCALVC_TOOLBAR_D100_C1/shellcont/shell",
    "GridID");
// Select first row
sapgui_grid_select_rows("One row", 
        "{GridID}", 
        "0", 
        BEGIN_OPTIONAL, 
            "AdditionalInfo=sapgui1023", 
        END_OPTIONAL);
sapgui_grid_clear_selection("", "{GridID}", LAST );
// Select three rows listed explicitly
sapgui_grid_select_rows("Three rows listed", 
        "{GridID}", 
        "1,3,5", 
        LAST );
sapgui_grid_clear_selection("", "{GridID}", LAST );
// Select rows with combination of list and range syntax
sapgui_grid_select_rows("Six rows, listed and range", 
        "{GridID}", 
        "1,2,6-9",
        LAST );