Share this page

# sapgui_text_edit_scroll_to_line

Text Edit Control Functions

Scrolls to line in text edit control.

    int sapgui_text_edit_scroll_to_line( const char *description, const char *textEditID, const char *lineNumber, [args,]  LAST );

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

sapgui_text_edit_scroll_to_line emulates a users scrolling until the line is visible. The line is not selected.

## 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 shows sapgui_text_edit_scroll_to_line emulating a user scrolling to the tenth line of a text edit control.

Copy code

    sapgui_text_edit_scroll_to_line("Scroll Demo",
        "usr/cntlSRC/shellcont/shell",
        "10",
        BEGIN_OPTIONAL,
            "AdditionalInfo=sapgui2020",
        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: