Share this page

# sapgui_select_tab

General Object Functions

Selects a tabbed page.

    int sapgui_select_tab( const char *description, const char *tabID, [args,] LAST );

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

sapgui_select_tab activates a tabbed page. It emulates a user clicking on the tab tabID.

## 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_select_tab to select a tabbed page, then change the selection.

    // Select the "Control" tab

    sapgui_select_tab("Control",

            "usr/tabsTABSTRIP1/tabpTAB2", LAST );

    // Output is Control tab is selected

    if (sapgui_is_tab_selected("Check Control Tab",

            "usr/tabsTABSTRIP1/tabpTAB2")

        )

            lr_output_message("Control tab is selected");

        else

            lr_output_message("Control tab is not selected");

    sapgui_select_tab("Period closing",

            "usr/tabsTABSTRIP1/tabpTAB3", LAST );

    // Check Control tab again after selecting a different tab

    // Output is "Control tab is not selected"

    if (sapgui_is_tab_selected("Check Control Tab",

            "usr/tabsTABSTRIP1/tabpTAB2")

        )

            lr_output_message("Control tab is selected");

        else

            lr_output_message("Control tab is not selected");

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: