Share this page
SAPGuiLabel Object
Description
A static text label 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 SAPGuiLabel object.
Note: You can also view a list and descriptions of the SAPGuiLabel 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. |
 SetCaretPos | Sets the position of the cursor within the static text label. |
| SetFocus | Sets the focus on a static text label 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. |
SetCaretPos Method
Description
Sets the position of the cursor within the static text label.
Syntax
object.SetCaretPos (Position)
Arguments
| Parameter | Description |
|---|---|
| Position |
Required. A long integer value. The character position where you want to place the cursor. Position numbers begin with 0. |
Return Type
None.
Example
Place the Cursor at the Beginning of a Text Label (VBScript)
'The following example uses the SetCaretPos method to place the cursor at the beginning of the "X" static
'text label and then clicks the "Blocking reason" button. When the button is clicked, a status bar message
'displays the operation that was performed. A checkpoint on the status bar verifies that the proper operation
'was performed on the label.
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiLabel("X").SetFocus
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiLabel("X").SetCaretPos 0
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiButton("Blocking reason").Click
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiStatusBar("StatusBar").Check CheckPoint("StatusBar")
SetFocus Method
Description
Sets the focus on a static text label 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
Set the Focus on a Text Label (VBScript)
'The following example uses the SetFocus method to set the focus on the "X" static text label and then clicks
'the "Blocking reason" button. When the button is clicked, a status bar message displays the operation that
'was performed. A checkpoint on the status bar verifies that the proper operation was performed.
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiLabel("X").SetFocus
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiLabel("X").SetCaretPos 0
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiButton("Blocking reason").Click
SAPGuiSession("Session").SAPGuiWindow("Invoice Items_2").SAPGuiStatusBar("StatusBar").Check CheckPoint("StatusBar")
See also:
