Share this page
SAPGuiCheckBox Object
Description
A check box 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 SAPGuiCheckBox object.
Note: You can also view a list and descriptions of the SAPGuiCheckBox 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. |
| RefreshObject | Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
 Set | Sets the value of a check box in an SAP GUI for Windows application. |
| SetFocus | Sets the focus on a checkbox object 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. |
Set Method
Description
Sets the value of a check box in an SAP GUI for Windows application.
Syntax
object.Set (Value)
Arguments
| Parameter | Description |
|---|---|
| Value |
Required. A String value. Possible Values:
|
Return Type
None.
Example
Clear and Set Check Boxes (VBScript)
'The following example uses the Set method to clear the "Customizing" check box and select the
'"Transport of" check box.
SAPGuiSession("Session").SAPGuiWindow("Transport Organizer").SAPGuiCheckBox("Customizing").Set "OFF"
SAPGuiSession("Session").SAPGuiWindow("Transport Organizer").SAPGuiCheckBox("Transport of").Set "ON"
SetFocus Method
Description
Sets the focus on a checkbox object in an SAP GUI for Windows application.
Syntax
object.SetFocus
Return Type
None.
IMPORTANT
This method is recorded on the object that has the focus when information is sent to the SAP server during a recording session. This ensures that the focus is on the correct object during the test run.
Example
Ensure a Check Box is in Focux (VBScript)
'The following example uses the SetFocus method to ensure that the "Release" check box is in focus before
'the next operation is performed.
SAPGuiSession("Session").SAPGuiWindow("Transport Organizer").SAPGuiCheckBox("Customizing").Set "OFF"
SAPGuiSession("Session").SAPGuiWindow("Transport Organizer").SAPGuiCheckBox("Transport of").Set "ON"
SAPGuiSession("Session").SAPGuiWindow("Transport Organizer").SAPGuiCheckBox("Released").SetFocus
SAPGuiSession("Session").SAPGuiWindow("Transport Organizer").SAPGuiCheckBox("Released").Set "ON"
See also:
