Share this page
SAPGuiToolbar Object
Description
A toolbar in an SAP GUI for Windows application.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPGuiToolbar object.
Note: You can also view a list and descriptions of the SAPGuiToolbar description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.
Methods
 CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
| Check | Checks whether the actual value of an item matches the expected value. |
| CheckProperty | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
| ChildObjects | Returns the collection of child objects contained within the object. |
| GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
| GetROProperty | Returns the current value of the description property from the object in the application. |
| GetTOProperties | Returns the collection of properties and values used to identify the object. |
| GetTOProperty | Returns the value of the specified description property from the test object description. |
| Highlight | Highlights the object in the application. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
 PressButton | Presses the specified toolbar button. |
| PressContextButton | Presses the specified toolbar button to open the button's context menu. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| SelectMenuItem | Selects the specified menu item from the toolbar button context menu. |
| SelectMenuItemById | Selects the specified menu item from the toolbar button context menu based on its SAP ID. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| ToString | Returns a string that represents the test object. |
| WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
 Exist | Checks whether the object currently exists in the open application. |
| Object | Accesses the native methods and properties of the object. |
PressButton Method
Description
Presses the specified toolbar button.
Syntax
object.PressButton (Button)
Arguments
| Parameter | Description |
|---|---|
| Button |
Required. A String value. The button's ID. |
Return Type
None.
Example
Press a Toolbar Button to Open a Dialog Box (VBScript)
'The following example uses the PressButton method to click the "&FIND" toolbar button to open the "Find" dialog
'box and perform a text search.
SAPGuiSession("Session").SAPGuiWindow("Display Purch.").SAPGuiButton("Document overview").Click
SAPGuiSession("Session").SAPGuiWindow("Display Purch.").SAPGuiToolbar("ToolBarControl").PressButton "&FIND"
SAPGuiSession("Session").SAPGuiWindow("Find").SAPGuiEdit("Search term").Set "Apple*"
SAPGuiSession("Session").SAPGuiWindow("Find").SAPGuiButton("Ok").Click
PressContextButton Method
Description
Presses the specified toolbar button to open the button's context menu.
Syntax
object.PressContextButton (Button)
Arguments
| Parameter | Description |
|---|---|
| Button |
Required. A String value. The button's ID. |
Return Type
None.
IMPORTANT
Although UFT One successfully records and runs steps performed on context menus, the context menu is not displayed in the Active Screen or in your application during the test run.
Example
Press a Toolbar Button to Open a Context Menu (VBScript)
'The following example uses the PressContextButton method to click the "CREA_TB" toolbar button to open a context
'menu. It then selects the "Project" item from the context menu.
SAPGuiSession("Session").SAPGuiWindow("Project Builder").SAPGuiToolbar("ToolBarControl").PressContextButton "CREA_TB"
SAPGuiSession("Session").SAPGuiWindow("Project Builder").SAPGuiToolbar("ToolBarControl").SelectMenuItem "Project"
SelectMenuItem Method
Description
Selects the specified menu item from the toolbar button context menu.
Syntax
object.SelectMenuItem (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value. The menu item name, full path, or numeric index can denote the item. Index values begin with 1. For a full path, separate items with semicolons (;). |
Return Type
None.
IMPORTANT
This method is recorded only for toolbar context menus that send an event corresponding to the PressContextButton method.
This method is supported only for separate toolbars. It is not supported for toolbars in grid controls.
Although UFT One successfully records and runs steps performed on context menus, the context menu is not displayed in the Active Screen or in your application during the test run.
Example
Select an Item from a Context Menu (VBScript)
'The following example uses the SelectMenuItem method to select the "Project" item from the context menu (opened
'by clicking the "CREA_TB" toolbar button).
SAPGuiSession("Session").SAPGuiWindow("Project Builder").SAPGuiToolbar("ToolBarControl").PressContextButton "CREA_TB"
SAPGuiSession("Session").SAPGuiWindow("Project Builder").SAPGuiToolbar("ToolBarControl").SelectMenuItem "Project"
SelectMenuItemById Method
Description
Selects the specified menu item from the toolbar button context menu based on its SAP ID.
Syntax
object.SelectMenuItemById (Id)
Arguments
| Parameter | Description |
|---|---|
| Id |
Required. A String value. The SAP ID of the context menu item. |
Return Type
None.
IMPORTANT
This method is recorded for separate toolbar context menus that do not send an event corresponding to the PressContextButton method and for all toolbars inside grid controls. For these objects, neither a PressContextButton nor PressButton method is recorded before the SelectMenuItemById method.
Example
Select an Item from a Context Menu (VBScript)
'The following example uses the SelectMenuItemById method to click the "&FILTER" toolbar context menu item ID.
SAPGuiSession("Session").SAPGuiWindow("Display Purch.").SAPGuiTable("GridViewCtrl").SelectColumn "Material"
SAPGuiSession("Session").SAPGuiWindow("Display Purch.").SAPGuiToolbar("GridToolbar").SelectMenuItemById "&FILTER"
SAPGuiSession("Session").SAPGuiWindow("Determine values").SAPGuiEdit("%%DYN001-LOW").Set "100-433"
SAPGuiSession("Session").SAPGuiWindow("Determine values").SAPGuiButton("Execute (Enter)").Click
See also:
