---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# SAP element-level method descriptions

# SAP element-level method descriptions {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 16 minutes to read  
The SAP connector provides various element-level methods that you can use to automate actions on the SAP screen UI elements, for example, a button or a check box.

## Common methods {#sap-element-methods__section_azs_m5v_12c}

The following methods apply to all elements on the SAP screen.  
Note:  
Any other elements that you see on the SAP screen that aren't listed in this topic support only the common methods.

Highlight{#sap-element-methods__dlentry_ks3_jlk_q1c}
:   Highlights the element on the SAP screen.

IsCreated{#sap-element-methods__dlentry_l11_llk_q1c}
:   Returns `true` if the element is present on the SAP screen, and `false` if the element is not present.

MouseClick{#sap-element-methods__dlentry_a5s_qlk_q1c}
:   Performs a mouse-click action on the element on the SAP screen.{#sap-element-methods__table_b5s_qlk_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | clickType | Option to select the type of mouse click: left or right. | Data In | Enum | Left | No |
    [Table 1. MouseClick method parameters]

    {#sap-element-methods__table_b5s_qlk_q1c}

SendKeys{#sap-element-methods__dlentry_jnx_rjl_zdc}
:   Sends the keyboard strokes such as Enter or Ctrl, to the element on the SAP screen.  
    {#sap-element-methods__table_gy1_ytx_ydc__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | keys | Keyboard strokes that you want to send to the element. | Data In | String | NA | Yes |
    | clearExistingValue | Option to specify whether to clear the existing value of the element before entering the keys value. | Data In | Boolean | False | No |
    | typeDelay | Option to specify the time delay in seconds between each key stroke. | Data In | Double | 0.09 | No |
    [Table 2. SendKeys method parameters]

    {#sap-element-methods__table_gy1_ytx_ydc}

SetFocus{#sap-element-methods__dlentry_j5g_nlk_q1c}
:   Sets focus on the element on the SAP screen.

WaitForCreate{#sap-element-methods__dlentry_lvb_5lk_q1c}
:   Waits for the specified duration while the element is being loaded. This enables all the dynamic controls to load.{#sap-element-methods__table_mvb_5lk_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | timeoutInSeconds | Duration in seconds after which the method times out. | Data In | Integer | 30 seconds | No |
    [Table 3. WaitForCreate method parameters]

    {#sap-element-methods__table_mvb_5lk_q1c}

## GuiButton methods {#sap-element-methods__section_aht_5vv_12c}

Click{#sap-element-methods__dlentry_owc_313_12c}
:   Selects the button on the SAP screen.

## GuiCheckbox methods {#sap-element-methods__dlentry_x4y_3wv_12c}

Check{#sap-element-methods__dlentry_bfc_yrb_s1c}
:   Selects the check box on the SAP screen.

IsChecked{#sap-element-methods__dlentry_nhz_grc_s1c}
:   Returns `true` if the element is selected on the SAP screen, and `false` if the element isn't selected.

Uncheck{#sap-element-methods__dlentry_mkk_hsb_s1c}
:   Clears the check box on the SAP screen.

## GuiComboBox {#sap-element-methods__section_kbb_qbw_12c}

Get{#sap-element-methods__dlentry_ufs_xgl_q1c}
:   Gets the selected value of the combo box on the SAP screen.

GetIconName{#sap-element-methods__dlentry_sqn_phl_q1c}
:   Gets the property icon name of the element on the SAP screen.

GetList{#sap-element-methods__dlentry_as5_ygl_q1c}
:   Gets all the list of values from the combo box on the SAP screen.

Set{#sap-element-methods__dlentry_gcm_hhl_q1c}
:   Sets the value of the combo box against the key passed.{#sap-element-methods__table_apf_khl_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | value | Value that you want to set for the combo box. | Data In | String | None | Yes |
    | selectedItem | Option to specify whether you want to set the value for "Key" or "Value". | Data In | Enum | None | Yes |
    [Table 4. Set method parameters]

    {#sap-element-methods__table_apf_khl_q1c}

## GuiCtrlGridView {#sap-element-methods__section_jjx_h3c_b2c}

ClickButtonCell{#sap-element-methods__dlentry_jgp_njc_b2c}
:   Selects a button in the grid cell defined by the row number and the column code.{#sap-element-methods__table_e5r_rjc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the grid. | Data In | Integer | None | Yes |
    | columnCode | The column identifier of the grid cell. | Data In | String | None | Yes |
    [Table 5. ClickButtonCell method parameters]

    {#sap-element-methods__table_e5r_rjc_b2c}

ClickCell{#sap-element-methods__dlentry_u1t_z3c_b2c}
:   Selects a grid cell defined by the row number and the column code.{#sap-element-methods__table_gkx_kkc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the grid. | Data In | Integer | None | Yes |
    | columnCode | The column identifier of the grid cell. | Data In | String | None | Yes |
    [Table 6. ClickCell method parameters]

    {#sap-element-methods__table_gkx_kkc_b2c}

DeselectAllRows{#sap-element-methods__dlentry_bkz_z3c_b2c}
:   Deselects all the rows that are selected in the grid.

GetCellType{#sap-element-methods__dlentry_tlf_1jc_b2c}
:   Retrieves the type of the grid cell defined by the row number and the column code.{#sap-element-methods__table_zsg_pkc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the grid. | Data In | Integer | None | Yes |
    | columnCode | The column identifier of the grid cell. | Data In | String | None | Yes |
    [Table 7. GetCellType method parameters]

    {#sap-element-methods__table_zsg_pkc_b2c}

GetCellValue{#sap-element-methods__dlentry_vdm_1jc_b2c}
:   Retrieves the value of the grid cell defined by the row number and the column code.{#sap-element-methods__table_e5c_5kc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the grid. | Data In | Integer | None | Yes |
    | columnCode | The column identifier of the grid cell. | Data In | String | None | Yes |
    [Table 8. GetCellValue method parameters]

    {#sap-element-methods__table_e5c_5kc_b2c}

GetColumns{#sap-element-methods__dlentry_sns_1jc_b2c}
:   Retrieves the list of active column headers of the grid.

GetColumnsKeyValuePair{#sap-element-methods__dlentry_pdz_1jc_b2c}
:   Retrieves the column name and column code as key-value pair from the columns of the grid.

GetRowCount{#sap-element-methods__dlentry_c5g_bjc_b2c}
:   Retrieves the number of the rows of the grid.

GetRows{#sap-element-methods__dlentry_dkr_bjc_b2c}
:   Retrieves the number of grid rows defined in the rowNumber parameter, starting from the row defined in the startIndex parameter.{#sap-element-methods__table_lkv_2lc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | startIndex | The starting row index to begin retrieving rows. | Data In | Integer | None | Yes |
    | rowNumber | Indicates the number of rows to retrieve from the grid | Data In | Integer | None | Yes |
    [Table 9. GetRows method parameters]

    {#sap-element-methods__table_lkv_2lc_b2c}

GetRowsByColumn{#sap-element-methods__dlentry_o3z_bjc_b2c}
:   Retrieves a subset of rows from a specific column based on the startIndex, rowNumber, and columnCode parameters.{#sap-element-methods__table_w2p_vnc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | startIndex | The starting index of the row to begin retrieving the data in the specified column (columnCode). | Data In | Integer | None | Yes |
    | rowNumber | The number of rows to retrieve starting from the startIndex. | Data In | Integer | None | Yes |
    | columnCode | The column from which the row data is retrieved. | Data In | String | None | Yes |
    [Table 10. GetRowsByColumn method parameters]

    {#sap-element-methods__table_w2p_vnc_b2c}

GetSelectedColumns{#sap-element-methods__dlentry_g2g_cjc_b2c}
:   Retrieves the columns that are selected.

GetSelectedRows{#sap-element-methods__dlentry_m5n_cjc_b2c}
:   Retrieves the rows that are selected.

GetSingleRow{#sap-element-methods__dlentry_sm5_cjc_b2c}
:   Retrieves a specific row of the grid defined by the row number.{#sap-element-methods__table_csb_m4c_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index (or row number) specifying which row of the grid you want to retrieve data for. | Data In | Integer | None | Yes |
    [Table 11. GetSingleRow method parameters]

    {#sap-element-methods__table_csb_m4c_b2c}

GetVisibleRows{#sap-element-methods__dlentry_vwb_djc_b2c}
:   Retrieves the rows that are visible.

SelectAllRows{#sap-element-methods__dlentry_nfj_djc_b2c}
:   Selects all rows of the grid.

SelectCell{#sap-element-methods__dlentry_mlv_djc_b2c}
:   Selects the grid cell defined by the row number and the column code.{#sap-element-methods__table_jcf_cqc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the grid. | Data In | Integer | None | Yes |
    | columnCode | The column identifier of the grid cell. | Data In | String | None | Yes |
    [Table 12. SelectCell method parameters]

    {#sap-element-methods__table_jcf_cqc_b2c}

SelectContextMenuItemById{#sap-element-methods__dlentry_d52_2jc_b2c}
:   Selects the context menu item from the grid based on the ID that you specify.{#sap-element-methods__table_np2_gqc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | Id | The unique identifier of the context menu item you want to select. | Data In | String | None | Yes |
    [Table 13. SelectContextMenuItemById method parameters]

    {#sap-element-methods__table_np2_gqc_b2c}

SelectContextMenuItemByPosition{#sap-element-methods__dlentry_cpl_2jc_b2c}
:   Selects the context menu item from the grid based on the position that you specify.{#sap-element-methods__table_phg_mqc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | menuItemPosition | The position of the context menu item that you want to select. | Data In | String | None | Yes |
    [Table 14. SelectContextMenuItemByPosition method parameters]

    {#sap-element-methods__table_phg_mqc_b2c}

SelectContextMenuItemByText{#sap-element-methods__dlentry_zqs_2jc_b2c}
:   Selects the context menu item from the grid based on the text that you specify.{#sap-element-methods__table_fmk_pqc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | menuItemText | The text of the context menu item that you want to select. | Data In | String | None | Yes |
    [Table 15. SelectContextMenuItemByText method parameters]

    {#sap-element-methods__table_fmk_pqc_b2c}

SelectSingleRow{#sap-element-methods__dlentry_unz_2jc_b2c}
:   Selects the row of the grid defined by the row number.{#sap-element-methods__table_pjz_sqc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row number that the method uses to select a row in the grid. | Data In | String | None | Yes |
    [Table 16. SelectSingleRow method parameters]

    {#sap-element-methods__table_pjz_sqc_b2c}

SelectToolbarMenuItemById{#sap-element-methods__dlentry_w1g_fjc_b2c}
:   Selects the toolbar menu item from the grid based on the ID that you specify.{#sap-element-methods__table_nzv_zqc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | Id | The unique identifier of the toolbar menu item you want to select. | Data In | String | None | Yes |
    [Table 17. SelectToolbarMenuItemById method parameters]

    {#sap-element-methods__table_nzv_zqc_b2c}

SelectToolbarMenuItemByPosition{#sap-element-methods__dlentry_h14_fjc_b2c}
:   Selects the toolbar menu item from the grid based on the position that you specify.{#sap-element-methods__table_mg3_1rc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | menuItemPosition | The position (or index) of a menu item in the toolbar. | Data In | Integer | None | Yes |
    [Table 18. SelectToolbarMenuItemByPosition method parameters]

    {#sap-element-methods__table_mg3_1rc_b2c}

SelectToolbarMenuItemByText{#sap-element-methods__dlentry_cfv_fjc_b2c}
:   Selects the toolbar menu item from the grid based on the text that you specify.{#sap-element-methods__table_byy_1rc_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | menuItemText | The text displayed on the toolbar menu item that you want to select. | Data In | String | None | Yes |
    [Table 19. SelectToolbarMenuItemByText method parameters]

    {#sap-element-methods__table_byy_1rc_b2c}

SetCellValue{#sap-element-methods__dlentry_qxb_gjc_b2c}
:   Sets the value of a cell in a grid defined by the row number and the column code.{#sap-element-methods__table_ujh_w5c_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | value | The value is set for the cell. | Data In | String | None | Yes |
    | rowNumber | The row number of the cell to modify. | Data In | Integer | None | Yes |
    | columnCode | The code (or identifier) for the column of the cell to modify. | Data In | String | None | Yes |
    [Table 20. SetCellValue method parameters]

    {#sap-element-methods__table_ujh_w5c_b2c}

## GuiLabel {#sap-element-methods__section_edt_c2w_12c}

GetText{#sap-element-methods__dlentry_ess_zzb_s1c}
:   Retrieves the text of the label on the SAP screen.

## GuiPassword {#sap-element-methods__section_utd_p2w_12c}

SetText{#sap-element-methods__dlentry_mwk_b1c_s1c}
:   Sets a given value as a password in the Password element on the SAP screen.

## GuiRadioButton {#sap-element-methods__section_i13_tcw_12c}

IsChecked
:   Returns `true` if the radio button is selected, and `false` if not selected.

Select{#sap-element-methods__dlentry_f5z_pqc_s1c}
:   Select the radio button on the SAP screen.

## GuiStatusBar {#sap-element-methods__section_stj_1fw_12c}

GetStatus{#sap-element-methods__dlentry_hmv_glk_q1c}
:   Retrieves the status information of a specific SAP screen.

## GuiTab {#sap-element-methods__section_tvj_kfw_12c}

SelectTab{#sap-element-methods__dlentry_orm_thd_s1c}
:   Selects the tab on the SAP screen.

## GuiTableControl {#sap-element-methods__section_a3c_vfw_12c}

DeselectVisibleRow{#sap-element-methods__dlentry_zm1_tvs_q1c}
:   Clears a visible row based on the row number that you specify.{#sap-element-methods__table_rgz_vvs_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the table. | Data In | Integer | None | Yes |
    [Table 21. DeselectVisibleRow method parameters]

    {#sap-element-methods__table_rgz_vvs_q1c}

DeselectAllVisibleRows{#sap-element-methods__dlentry_gzn_rvs_q1c}
:   Clears all the selected rows.

DeselectRow{#sap-element-methods__dlentry_nbh_5vs_q1c}
:   Clears a particular row based on the row number that you specify.{#sap-element-methods__table_mhm_zvs_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the table. | Data In | Integer | None | Yes |
    [Table 22. DeselectRow method parameters]

    {#sap-element-methods__table_mhm_zvs_q1c}

GetAllVisibleRows{#sap-element-methods__dlentry_a33_1ws_q1c}
:   Returns all the visible rows in the table.

GetColumnNames{#sap-element-methods__dlentry_h4m_fws_q1c}
:   Gets the list of active column headers in the table.

GetMaximumScrollOffset{#sap-element-methods__dlentry_qbs_mws_q1c}
:   Gets the maximum value up to which scrolling is possible within the table.{#sap-element-methods__table_hlj_4ws_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | type | Option to select the type of scroll: horizontal or vertical. | Data In | Enum | None | Yes |
    [Table 23. GetMaximumScrollOffset method parameters]

    {#sap-element-methods__table_hlj_4ws_q1c}

GetScrollPosition{#sap-element-methods__dlentry_str_rys_q1c}
:   Gets the current position of the scroll bar.{#sap-element-methods__table_fz2_tys_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | type | Option to select the type of scroll: horizontal or vertical. | Data In | Enum | None | Yes |
    [Table 24. GetScrollPosition method parameters]

    {#sap-element-methods__table_fz2_tys_q1c}

GetSingleRow{#sap-element-methods__dlentry_kdv_gws_q1c}
:   Retrieves a specific row of the table defined by the row number.{#sap-element-methods__table_qcv_jws_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the table. | Data In | Integer | None | Yes |
    [Table 25. GetSingleRow method parameters]

    {#sap-element-methods__table_qcv_jws_q1c}

GetTable{#sap-element-methods__dlentry_hsp_kws_q1c}
:   Fetches the entire table.

GetVisibleRowCount{#sap-element-methods__dlentry_zg5_cws_q1c}
:   Returns count of visible rows.

ScrollDownByOneRow{#sap-element-methods__dlentry_ojz_1zs_q1c}
:   Scrolls down to move the focus to the next row.

ScrollToHorizontalPosition{#sap-element-methods__dlentry_f3x_bzs_q1c}
:   Scrolls horizontally to move focus to the specified position.{#sap-element-methods__table_bgp_r4f_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | position | Position of the scroll. | Data In | Integer | None | Yes |
    [Table 26. ScrollToHorizontalPosition method parameters]

    {#sap-element-methods__table_bgp_r4f_b2c}

ScrollToNextPage{#sap-element-methods__dlentry_wm1_5gw_12c}
:   Scrolls down to move the focus to the next page.

ScrollToPreviousPage{#sap-element-methods__dlentry_xm1_5gw_12c}
:   Scrolls up to move the focus to the previous page.

ScrollToVerticalPosition{#sap-element-methods__dlentry_lqf_dzs_q1c}
:   Scrolls vertically to move focus to the specified position.{#sap-element-methods__table_inm_t4f_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | position | Position of the scroll. | Data In | Integer | None | Yes |
    [Table 27. ScrollToVerticalPosition method parameters]

    {#sap-element-methods__table_inm_t4f_b2c}

ScrollUpByOneRow{#sap-element-methods__dlentry_gcb_zys_q1c}
:   Scrolls up to move the focus to the previous row.

SelectAllRows{#sap-element-methods__dlentry_cnl_pvs_q1c}
:   Selects all the rows of the table, whether they are visible.

SelectSingleRow{#sap-element-methods__dlentry_gq5_xqs_q1c}
:   Selects the row of the table defined by the row number.{#sap-element-methods__table_hb4_crs_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the table. | Data In | Integer | None | Yes |
    [Table 28. GetRowsByColumn method parameters]

    {#sap-element-methods__table_hb4_crs_q1c}

SelectCell{#sap-element-methods__dlentry_dpk_hrs_q1c}
:   Selects a cell in the table defined by the row number and the column code.{#sap-element-methods__table_ghn_3rs_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the table. | Data In | Integer | None | Yes |
    | columnCode | Code number of the column in the cell. | Data In | String | None | Yes |
    [Table 29. SelectCell method parameters]

    {#sap-element-methods__table_ghn_3rs_q1c}

SelectVisibleRow{#sap-element-methods__dlentry_d2y_mvs_q1c}
:   Selects a visible row of the table defined by the row number.{#sap-element-methods__table_dmz_nvs_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | rowNumber | The row index or row number of a cell in the table. | Data In | Integer | None | Yes |
    [Table 30. SelectVisibleRow method parameters]

    {#sap-element-methods__table_dmz_nvs_q1c}

## GuiTextBox {#sap-element-methods__section_stj_sfw_12c}

GetText{#sap-element-methods__dlentry_x2q_2gw_12c}
:   Retrieves the text of the text box on the SAP screen.

SetCaretPosition{#sap-element-methods__dlentry_k53_c1c_s1c}
:   Sets the caret to the specified position in the text box on the SAP screen.{#sap-element-methods__table_ijx_d1c_s1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | position | Position of the caret. | Data In | Integer | None | Yes |
    [Table 31. SetCaretPosition method parameters]

    {#sap-element-methods__table_ijx_d1c_s1c}

SetText{#sap-element-methods__dlentry_xwn_ngw_12c}
:   Sets a given value in the text box on the SAP screen.{#sap-element-methods__table_cq1_pmd_b2c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | text | Text value that you want to set in the text box. | Data In | String | None | Yes |
    [Table 32. SetText method parameters]

    {#sap-element-methods__table_cq1_pmd_b2c}

## GuiTree {#sap-element-methods__section_ndp_wfw_12c}

Check{#sap-element-methods__dlentry_yqk_2rw_12c}
:   Selects a particular item in a node on the SAP screen.  
    {#sap-element-methods__table_idb_2rw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 33. Check method parameters]

    {#sap-element-methods__table_idb_2rw_12c}

ClickNodeItem{#sap-element-methods__dlentry_hdq_bqw_12c}
:   Clicks a particular item in a node on the SAP screen.{#sap-element-methods__table_vcr_lqw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 34. ClickNodeItem method parameters]

    {#sap-element-methods__table_vcr_lqw_12c}

CollapseNodeItem{#sap-element-methods__dlentry_epf_4mf_b2c}
:   Collapses a particular node item on the SAP screen.  
    {#sap-element-methods__table_g1q_wrw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    [Table 35. CollapseNodeItem method parameters]

    {#sap-element-methods__table_g1q_wrw_12c}

DoubleClickNode{#sap-element-methods__dlentry_nhq_prw_12c}
:   Performs a double-click mouse action on a particular node on the SAP screen.  
    {#sap-element-methods__table_txq_mrw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    [Table 36. DoubleClickNode method parameters]

    {#sap-element-methods__table_txq_mrw_12c}

DoubleClickNodeItem{#sap-element-methods__dlentry_kfj_trw_12c}
:   Performs a double-click mouse action on a particular item in a node on the SAP screen.  
    {#sap-element-methods__table_dsf_rrw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 37. DoubleClickNodeItem method parameters]

    {#sap-element-methods__table_dsf_rrw_12c}

GetColumnsKeyValuePair{#sap-element-methods__dlentry_ad3_bqw_12c}
:   Retrieves the column name and column code as key-value pair from the columns of the tree.

GetTreeType{#sap-element-methods__dlentry_ggf_1qw_12c}

:   Retrieves the type of the tree, such as simple, list, or column. If the type isn't one of these, the method returns an empty value.

GetNodeKeyByPath{#sap-element-methods__dlentry_dtx_bqw_12c}
:   Retrieves the node key based on the path that you specify.  
    {#sap-element-methods__table_spl_bsw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | path | Route or hierarchy to find a specific node in the tree. | Data In | String | None | Yes |
    [Table 38. GetNodeKeyByPath method parameters]

    {#sap-element-methods__table_spl_bsw_12c}

GetNodeKeyByText{#sap-element-methods__dlentry_crf_cqw_12c}
:   Retrieves the node key based on the text that you specify.  
    {#sap-element-methods__table_wf3_jsw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeText | The text value that you want to match with a node key. The value is matched to any node's text, ignoring case and extra spaces. | Data In | String | None | Yes |
    [Table 39. GetNodeKeyByText method parameters]

    {#sap-element-methods__table_wf3_jsw_12c}

GetNodeItemText{#sap-element-methods__dlentry_vqn_cqw_12c}
:   Retrieves the text of the node item based on the key and name that you specify.{#sap-element-methods__table_o4g_ktw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | key | The key associated with the node. This key is the unique identifier of the node that you want to retrieve the text of. | Data In | String | None | Yes |
    | name | The name of the specific item or property within the node, used to filter or further identify the node. | Data In | String | None | Yes |
    [Table 40. GetNodeItemText method parameters]

    {#sap-element-methods__table_o4g_ktw_12c}

GetSelectedNodes{#sap-element-methods__dlentry_unv_cqw_12c}
:   Retrieves the values of the selected nodes.

GetNodeItemCheckBoxState{#sap-element-methods__dlentry_jbw_25w_12c}
:   Retrieves the state of a check box in a node item.  
    {#sap-element-methods__table_xtf_25w_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 41. GetNodeItemCheckBoxState method parameters]

    {#sap-element-methods__table_xtf_25w_12c}

PressNodeItemButton{#sap-element-methods__dlentry_ff4_xxw_12c}
:   Clicks the button in a specified node item on the SAP screen.  
    {#sap-element-methods__table_qwc_wxw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 42. PressNodeItemButton method parameters]

    {#sap-element-methods__table_qwc_wxw_12c}

SelectNodeItem{#sap-element-methods__dlentry_ubf_2yw_12c}
:   Selects the specified node item on the SAP screen.  
    {#sap-element-methods__table_gqx_byw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 43. SelectNodeItem method parameters]

    {#sap-element-methods__table_gqx_byw_12c}

SelectNode{#sap-element-methods__dlentry_z3g_mnf_b2c}
:   Selects the specified node on the SAP screen.  
    {#sap-element-methods__table_lw3_fyw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    [Table 44. SelectNode method parameters]

    {#sap-element-methods__table_lw3_fyw_12c}

SelectContextMenuItemById{#sap-element-methods__dlentry_gqd_dqw_12c}
:   Selects a context menu item based on the ID that you specify.  
    {#sap-element-methods__table_ndh_qzw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | type | The type of context menu (Tree,Node,Node Item). | Data In | Enum | None | Yes |
    | menuId | The identifier of the context menu item that must be selected. | Data In | String | None | Yes |
    | nodeKey | Unique identifier for a specific node in the tree on which the context menu is to be invoked. | Data In | String | None | Yes |
    | ColumnName | The name of the column within the node. This helps narrow down which specific column in the node the context menu should apply to. | Data In | String | None | Yes |
    [Table 45. SelectContextMenuItemById method parameters]

    {#sap-element-methods__table_ndh_qzw_12c}

SelectContextMenuItemByText{#sap-element-methods__dlentry_iyr_dqw_12c}
:   Selects a context menu item based on the text that you specify.  
    {#sap-element-methods__table_byc_rbx_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | type | The type of context menu (Tree,Node,Node Item). | Data In | Enum | None | Yes |
    | menuText | The visible text of the context menu item that you want to select. | Data In | String | None | Yes |
    | nodeKey | Unique identifier for a specific node in the tree on which the context menu is to be invoked. | Data In | String | None | Yes |
    | ColumnName | The name of the column within the node. This name helps narrow down which specific column in the node the context menu should apply to. | Data In | String | None | Yes |
    [Table 46. SelectContextMenuItemByText method parameters]

    {#sap-element-methods__table_byc_rbx_12c}

SelectContextMenuItemByPosition{#sap-element-methods__dlentry_ehb_2qw_12c}
:   Selects a context menu item based on the position that you specify.  
    {#sap-element-methods__table_lnw_1cx_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | type | The type of context menu (Tree,Node,Node Item). | Data In | Enum | None | Yes |
    | menuPosition | The position of the context menu item that you want to select. It could be the index or a string representing the position. | Data In | String | None | Yes |
    | nodeKey | Unique identifier for a specific node in the tree on which the context menu is to be invoked. | Data In | String | None | Yes |
    | ColumnName | The name of the column within the node. This name helps narrow down which specific column in the node the context menu should apply to. | Data In | String | None | Yes |
    [Table 47. SelectContextMenuItemByPosition method parameters]

    {#sap-element-methods__table_lnw_1cx_12c}

Uncheck{#sap-element-methods__dlentry_cdy_hrw_12c}
:   Clears a particular item in a node from the SAP screen.  
    {#sap-element-methods__table_k23_grw_12c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | nodeKey | Unique identifier for a specific node within the tree. | Data In | String | None | Yes |
    | column | The column name or identifier within the specified node. | Data In | String | None | Yes |
    [Table 48. Uncheck method parameters]

    {#sap-element-methods__table_k23_grw_12c}

## GuiUserArea {#sap-element-methods__section_yhv_sfw_12c}

ScrollToNextPage{#sap-element-methods__dlentry_h53_znw_12c}
:   Scrolls down to move the focus to the next page.

ScrollToPreviousPage{#sap-element-methods__dlentry_x2t_znw_12c}
:   Scrolls up to move the focus to the previous page.

SetHorizontalScroll{#sap-element-methods__dlentry_vh1_cdl_q1c}
:   Scrolls horizontally to a value that you specify.{#sap-element-methods__table_j2q_hdl_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | scrolVal | Numeric value for scroll bar. | Data In | Integer | None | Yes |
    [Table 49. SetHorizontalScroll method parameters]

    {#sap-element-methods__table_j2q_hdl_q1c}

SetVerticalScroll{#sap-element-methods__dlentry_gsv_4dl_q1c}
:   Scrolls vertically to a value that you specify.{#sap-element-methods__table_hsv_4dl_q1c__entry__6}

    | Parameter | Description | Data port entry type | Data type | Default value | Mandatory? |
    |-|-|-|-|-|-|
    | scrolVal | Numeric value for scroll bar. | Data In | Integer | None | Yes |
    [Table 50. SetVerticalScroll method parameters]

    {#sap-element-methods__table_hsv_4dl_q1c}