sapgui_grid_press_toolbar_context_button

Grid Functions

Clicks on a context button.

int sapgui_grid_press_toolbar_context_button( const char *description, const char *gridID, const char *buttonID, [args,] LAST );
description User entered text to aid in understanding script
gridIDObject ID Strings
buttonIDObject ID Strings
argsOptional Arguments
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_press_toolbar_context_button emulates a user opening a list of options by clicking on a context 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.

Example

This example uses sapgui_grid_press_toolbar_context_button to open a context button paired with a "Sum" button. The user chooses the "Sum" option from the list.

/ 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("(CtrlGrid)", 
        "{GridID}", 
        "SEATSOCC",LAST );
// Open context menu
sapgui_grid_press_toolbar_context_button("'Total'", 
        "{GridID}", 
        "&MB_SUM", 
        BEGIN_OPTIONAL, 
            "AdditionalInfo=sapgui1054", 
        END_OPTIONAL);
// Choose Sum from the list
sapgui_call_method("{GridID}", 
        "selectToolbarMenuItem", 
        "&SUMC",
        LAST );