sapgui_tree_open_node_context_menu

Tree Functions

Opens node context sensitive menu.

int sapgui_tree_open_node_context_menu( const char *description, const char *treeID, const char *nodeKey, [args,] LAST ) ;
description User entered text to aid in understanding script
treeIDObject ID Strings
nodeKeyObject ID Strings
argsOptional Arguments, often including Dynamic Tree Node Keys.
LAST A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_tree_open_node_context_menu emulates a user right-clicking on the tree node to open the context sensitive menu.

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_tree_open_node_context_menu to open the context menu for a node.

sapgui_tree_set_selected_node("HTML Control", 
    "shellcont/shell", 
    "000730", LAST );
sapgui_tree_open_node_context_menu("(CtrlTree)", 
    "shellcont/shell", // Tree ID
    "000730", // Node ID
    BEGIN_OPTIONAL, 
        "AdditionalInfo=sapgui1025", 
    END_OPTIONAL);