Share this page
SAPGuiOKCode Object
Description
An OK Code box in an SAP GUI for Windows application.
IMPORTANT
An OK Code box is an edit box in which a command is entered in order to navigate to the required screen.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPGuiOKCode object.
Note: You can also view a list and descriptions of the SAPGuiOKCode 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 UFT One to re-identify the object in the application the next time a step refers to this object. |
 Set | Sets the OKCode command. |
| 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 OKCode command.
Syntax
object.Set (Text)
Arguments
| Parameter | Description |
|---|---|
| Text |
Required. A String value. The command string. |
Return Type
None.
Example
Set a Specific Transaction Code (VBScript)
'The following example uses the Set method to set the "trip" transaction code and then uses the "SendKey ENTER"
'statement to press the keyboard ENTER key and navigate to the "trip" transaction.
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiOKCode("OKCode").Set "trip"
SAPGuiSession("Session").SAPGuiWindow("SAP Easy Access").SendKey ENTER
See also:
