Share this page

# sapgui_grid_press_toolbar_button

Grid Functions

Clicks a grid toolbar button.

    int sapgui_grid_press_toolbar_button( const char *description, const char *gridID, const char *buttonID, [args,] LAST );

description | User entered text to aid in understanding script
gridID | Object ID Strings
buttonID | Object ID Strings
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_press_toolbar_button emulates a user clicking on a grid toolbar button.

## 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.

## Examples

The following examples uses sapgui_grid_press_toolbar_button to sort and sum columns in a grid.

### Example 1: Sort a column

Copy code

    // Save the Grid ID in variable "GridID"
    lr_save_string(
        "/app/con[0]/ses[0]/wnd[0]/usr/cntlBCALV_GRID_DEMO_0100_CONT1/shellcont/shell",
           "GridID");
    sapgui_grid_select_columns("'Overview'",
            "{GridID}",
            "CONNID",
            BEGIN_OPTIONAL,
                "AdditionalInfo=sapgui1019",
            END_OPTIONAL);
    sapgui_grid_press_toolbar_button("'Sort in ascend. order'",
            "{GridID}",
            "&SORT_ASC", // Button ID
            BEGIN_OPTIONAL,
                "AdditionalInfo=sapgui1020",
            END_OPTIONAL);

### Example 2: Total a column

Copy code

    sapgui_grid_select_columns("(CtrlGrid)",
            "{GridID}",
            "PAYMENTSUM",
            BEGIN_OPTIONAL,
                "AdditionalInfo=sapgui1028",
            END_OPTIONAL);
    sapgui_grid_press_toolbar_button("'Total'",
            "{GridID}",
            "&MB_SUM",
            BEGIN_OPTIONAL,
                "AdditionalInfo=sapgui1029",
            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: