SapGuiVerifyTreeNodeText Function


This function verifies the text of a node in a SapGui tree control.

Include file



SapGuiVerifyTreeNodeText( in sControlId : string, 
                          in sNode      : string, 
                          in sValue     : string, 
                          in nOptions   : number optional, 
                          in nSeverity  : number optional := SEVERITY_ERROR ) : boolean;
Parameter Description
sControlId The unique id of a tree control.
sNode The name of the node.
sValue Compares the current text of the control to the value specified in this parameter according to the comparison flags in the third parameter.
nOptions This parameter specifies the type of check to be performed. Available options are:
  • SAPGUI_VERIFY_EQUAL. Verifies, whether the state of the checkbox's state is equal to the value specified in the second parameter.
  • SAPGUI_VERIFY_NOT_EQUAL. Verifies, whether the checkbox's state is not equal to the value specified in the second parameter.
  • SAPGUI_VERIFY_CASE_SENSITIVE. Performs a case sensitive comparison. By default the comparison is done case insensitive.
  • SAPGUI_VERIFY_IGNORE_WHITESPACE. Ignores any whitespaces found in the values to be compared.
nSeverity Optional: Severity of the error that is raised if the verification fails. Can be one of the following values:
  • SEVERITY_SUCCESS: Success; no error (numerical value: 0)
  • SEVERITY_INFORMATIONAL: Informational; no error (numerical value: 1)
  • SEVERITY_WARNING: Warning; no error (numerical value: 2)
  • SEVERITY_ERROR: (Default) Error; simulation continues (numerical value: 3)
  • SEVERITY_TRANS_EXIT: Error; the active transaction is aborted (numerical value: 4)
  • SEVERITY_PROCESS_EXIT: Error; the simulation is aborted (numerical value: 5)

Return value

  • true if successful
  • false otherwise


transaction TMain
    sConnID : string;

    // Connecting to SAP
    sConnID := SapGuiOpenConnection( " /SAP_CODEPAGE=1100 /FULLMENU 0 /3");

    // SAP
    SapGuiSetActiveWindow("wnd[0]", "SAP", SAPGUI_MATCH_ExactNoCase);

    // Logon to SAP System
    // Before running a test you have to customize the password parameter!
    SapGuiLogon("ddic", "*******", "000", "");

    // SAP Easy Access
    SapGuiSetActiveWindow("wnd[0]", "SAP Easy Access", SAPGUI_MATCH_ExactNoCase);

    // NodeName: Office
    // NodePath: 2\1
    SapGuiTreeExpandNode( "usr/cntlIMAGE_CONTAINER/shellcont/shell/shellcont[0]/shell", "Office", "0000000003", "Expand\\Office");
    SapGuiTreeExpandNode( "usr/cntlIMAGE_CONTAINER/shellcont/shell/shellcont[0]/shell", "Telephone Integration", "0000000005", "Expand\\Telephone Integration");
    SapGuiVerifyTreeNodeText( "usr/cntlIMAGE_CONTAINER/shellcont/shell/shellcont[0]/shell", "Office", "NodeText", SAPGUI_VERIFY_EQUAL, SEVERITY_ERROR);
  end TMain;