Share this page
SAPGuiButton Object
Description
A button 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 SAPGuiButton object.
Note: You can also view a list and descriptions of the SAPGuiButton 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. |
 Click | Clicks a button in an SAP GUI for Windows 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. |
| RefreshObject | Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
| SetFocus | Sets the focus on a button in an SAP GUI for Windows application. |
| 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. |
Click Method
Description
Clicks a button in an SAP GUI for Windows application.
Syntax
object.Click
Return Type
None.
Example
Check if a Button Exists (VBScript)
'The following example uses the Click method to check whether the "Document overview on" button exists.
'If it does, it clicks the button and checks whether the label changes to "Document overview off" after
'it is clicked.
If SAPGuiSession("Session").SAPGuiWindow("Create Purchase").SAPGuiButton("Document overview on").Exist(1) Then
SAPGuiSession("Session").SAPGuiWindow("CreatePurchase").SAPGuiButton("Document overview on").Click
SAPGuiSession("Session").SAPGuiWindow("Create Purchase").SAPGuiButton("Document overview off").Check
CheckPoint ("Document overview off")
End If
SetFocus Method
Description
Sets the focus on a button in an SAP GUI for Windows application.
Syntax
object.SetFocus
Return Type
None.
IMPORTANT
This method is supported only for buttons inside the Working Pane (the area between the SAP Gui for Windows toolbar and status bar).
This method is not recorded. To add this method to your test, use the Step Generator or enter it manually in the Keyword View or Editor. For more information, see the OpenText Functional Testing User Guide.
Example
Set the Focus on a Button (VBScript)
'The following example uses the SetFocus method to ensure that the "Create" button is the object in focus.
SAPGuiSession("Session").SAPGuiWindow("Personalstammdaten").SAPGuiEdit("Infotype").Set "24"
SAPGuiSession("Session").SAPGuiWindow("Personalstammdaten").SendKey 6
SAPGuiSession("Session").SAPGuiWindow("Person: Change").SAPGuiButton("Create").SetFocus
SAPGuiSession("Session").SAPGuiWindow("Person: Change").SAPGuiButton("Create").Click
See also:
