Share this page
SAPUITextEdit Object
Description
An SAPUI5 text edit control.
IMPORTANT
The SAPUITextEdit test object class extends the WebEdit test object class and inherits many of its operations and description properties.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPUITextEdit object.
Note: You can also view a list and descriptions of the SAPUITextEdit 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 specified object property achieves the specified 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. |
 Clear | Clears the text in the edit control. |
| Click | Clicks the object. |
| DoubleClick | Clicks on the object twice. |
| Drag | Performs the 'drag' part of a drag and drop operation. |
| Drop | Performs the 'drop' part of a drag and drop operation. |
| FireEvent | Triggers an event. |
| GetROProperty | Returns the current value of the specified 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. |
| HoverTap | When hover is supported, places the pointer on the object. Otherwise, taps the object. |
| LongPress | Presses and holds the object. |
| MiddleClick | Middle-clicks the object. |
| OpenPossibleEntries | Opens the list of possible values. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| Pan | Perform a pan gesture. |
| Pinch | Perform a pinch gesture. |
| Refresh | Clicks the Refresh button. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| RightClick | Right-clicks the object. |
| Search | Enters the specified text in the Search edit box and clicks the Search button. |
| Set | Enters the specified text in the edit box . |
| SetSecure | Sets the encrypted value of an edit box. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Submit | Submits a form. |
| Swipe | Swipes the object. |
| ToString | Returns a string that represents the current 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. |
Clear Method
Description
Clears the text in the edit control.
Syntax
object.Clear
Return Type
None
Example
Clear the Text from an Edit Field (VBScript)
'The following example clears all text from the text edit field.
Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUITextEdit("TextField-1-input").Clear
Click Method
Description
Clicks the object.
Syntax
object.Click [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Tip: You can enter MicNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y-coordinates for the click. Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None
IMPORTANT
- UFT One does not record the Click method for right- or middle-clicks. Instead, UFT One records the RightClick and MiddleClick methods.
- Recording options for this method are defined in the Advanced tab of the Web Options dialog box. For details, see the section on the Web > Advanced pane in the UFT One Help Center.
- For some Mozilla Firefox objects, this method is recorded only if a handler is present. For details, see the topic on working with multiple browsers in the UFT One Help Center.
Example
Click a Button (VBScript)
'The following example clicks a button in the application.
Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUIButton("Button20-01").Click
DoubleClick Method
Description
Clicks on the object twice.
Syntax
object.DoubleClick [interval], [x], [y]
Arguments
| Parameter | Description | ||
|---|---|---|---|
| interval |
Optional. A Variant.
| ||
| x |
Optional. An integer value. The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 | ||
| y |
Optional. An integer value. The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
Drag Method
Description
Performs the 'drag' part of a drag and drop operation.
Syntax
object.Drag [x], [y], [BUTTON], [Modifier]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate within the source object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate within the source object. Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to drag the object. Default value = micLeftBtn |
| Modifier |
Optional. A String value. The keyboard modifier that is pressed during the Drag operation. Possible values:
|
Return Type
None
IMPORTANT
Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur in the run session.
UFT One supports the following scenarios:
- Scenario A: One object is dragged onto another object. For example, you can drag a WebButton from one frame object (source object) to another object (target object), or drag a WebElement (source object) onto a Link object (target object) in the same frame.
- Scenario B: An object is moved from one location in a frame to another location in the same frame. In this case, the test object used for the Drag setp is the same as the test object used for the Drop step.
- Scenario C: An item within an object is moved to another location within that object (also known as drag and pan). For example, in a map application, you can relocate an image relative to itself or drag a Slider object.
General Note:
UFT One always runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run settings section of the Web > Advanced pane (Tools > Options > GUI Testing tab > Web pane > Advanced node).
Notes for Scenario A:
- When recording: You cannot record crossobject or cross-frame types of drag and drop operations (operations in which you try to drop an object on another object or in another frame). You can, however, insert these types of Drop steps manually. Note that it may be helfup to record a drag and drop operation on the object in order to determine valid coordinates for the Drag operation step. You will need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead.
- When running: If the application being tested supports scrolling, then UFT One supports scrolling when the Drag and Drop test objects are both located in the same frame. UFT One drags the Drag object to the edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then UFT One displays an error message when it reaches a step that requires scrolling.
- Run session. If you want to drag a test object from one frame to another, UFT One tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step will fail.
Notes for Scenario B and Scenario C:
- If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session, and this may cause the test steps to fail.
- During a run session, if the coordinates of a Drop step are located outside the visible frame area (for example, because your application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).
Example
Drag a Button Object. (VBScript)
'The following example drags a button object.
Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUIButton("Button20-01").Drag
Drop Method
Description
Performs the 'drop' part of a drag and drop operation.
Syntax
object.Drop [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the x-coordinate is relative to the upper left corner in the source location prior to being dragged. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the y-coordinate is relative to the upper left corner in the source location prior to being dragged. Default value = 0 |
Return Type
None
IMPORTANT
Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes and error to occur. For more information on Drag and Drop operations, see Drag Method.Example
Drop a Dragged Button Object (VBScript)'The following example drops a dragged button object. Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUIButton("Button20-01").Drop 90,100
FireEvent Method
Description
Triggers an event.
Syntax
object.FireEvent EventName, [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| EventName |
Required. A String value. The name of the event to trigger. Available events: onchange, onclick, ondblclick, onblur, onfocus, onmousedown, onmouseup, onmouseover, onmouseout, onsubmit, onreset, onpropertychange. |
| x |
Optional. An integer value. The x-coordinate, relative to the upper left corner of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate, relative to the upper left corner of the object. Default value = 0 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to fire the event. Default value = micLeftBtn |
Return Type
None
Example
Simulate an Event on a Button (VBScript)'The following example uses the FireEvent method to simulate the onmouseevent 'on the Button20-01 object. Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUIButton("Button20-01").FireEvent "onmouseover"
HoverTap Method
Description
When hover is supported, places the pointer on the object. Otherwise, taps the object.
Syntax
object.HoverTap [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
LongPress Method
Description
Presses and holds the object.
Syntax
object.LongPress [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| duration |
Optional. A Variant. The time period (in seconds) to hold the long tap gesture. You can specify partial seconds as a duration time. |
| x |
Optional. An integer value. The x-coordinate of the long tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
Example
Perform a LongPress on a Text Edit Field (VBScript)'The following example performs a LongPress on an SAPUITextEdit object. Device("Device").App("Mobile Web_2").MobileWebView("Web View").Page("Checkbox and radio inputs").LongPress 1,75,75
MiddleClick Method
Description
Middle-clicks the object.
Syntax
object.MiddleClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the middle click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the middle click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
- If UFT One does not record the MiddleClick method, it may be due to Web Event Recording Configuration settings that were preserved fro the upgrade of a previous UFT One version. In this case, you can enable recording of these methods by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the topic on the Custom Web Event Recording Configuration in the Add-ins section of the UFT One Help Center.
- When Event Replay is selected for the Replay type option (by using Tools > Options > GUI Testing tab > Web pane > Advanced node), UFT One fires onmousedown, focus, and onmouseup events for this method, which may cause slightly different behavior than the regular Click method with a micMiddleButton value for the Button argument.
Example
Click the Middle Mouse Button on a Button (VBScript)'The following example clicks the middle mouse button on the Button20-01 object. Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUIButton("Button20-01").MiddleClick
OpenPossibleEntries Method
Description
Opens the list of possible values.
Syntax
object.OpenPossibleEntries
Return Type
None
IMPORTANT
This method is applicable for text edit controls that use Autocomplete. These controls provide the ability to add suggestion values which help the user during the text input. During typing a list with suggestions is displayed which can directly be selected by the user.
Example
Open a List of Possible Entries for a Text Edit Field (VBScript)'The following example opens the list of the possible entries for a text edit field Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUITextEdit("VHF1-input").OpenPossibleEntries
Pan Method
Description
Perform a pan gesture.
Syntax
object.Pan deltaX, deltaY, [duration], [startX], [startY]
Arguments
| Parameter | Description |
|---|---|
| deltaX |
Required. An integer value. The distance moved on the x axis, relative to the start point. |
| deltaY |
Required. An integer value. The distance moved on the y axis, relative to the start point. |
| duration |
Optional. A Variant. The number of seconds required to perform the pan gesture. |
| startX |
Optional. An integer value. The x-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object. Default value = 0 |
| startY |
Optional. An integer value. The y-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported in Internet Explorer and older versions of FireFox.
Pinch Method
Description
Perform a pinch gesture.
Syntax
object.Pinch scale, [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| scale |
Required. A Variant. The zoom scale resulting from the pinch gesture. This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture. |
| duration |
Optional. A Variant. The number of seconds required to perform the pinch gesture. The default value is 1 second. |
| x |
Optional. An integer value. The x-coordinate of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported in Internet Explorer and older versions of FireFox.
Refresh Method
Description
Clicks the Refresh button.
Syntax
object.Refresh
Return Type
None
RightClick Method
Description
Right-clicks the object.
Syntax
object.RightClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. An integer value. The x-coordinate of the right click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| y |
Optional. An integer value. The y-coordinate of the right click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
Return Type
None
IMPORTANT
- If UFT One does not record the RightClick method, it may be due to Web Event Recording Configuration settings that were preserved from the upgrade of a previous UFT One version. In this case, you can enable recording of these methods by resetting the Web Event Recording Configuration to a preconfigured level. For details, see the topic on the Custom Web Event Recording Configuration in the Add-ins section of the UFT One Help Center.
- When Event Replay is selected for the Replay type option (by using Tools > Options > GUI Testing tab > Web pane > Advanced node), UFT One fires onmousedown, focus, onmouseup, and oncontextmenu events for this method, which may cause slightly different behavior than the regular Click method with a micRightButton value for the Button argument.
Example
Click the Right Mouse Button on a Button (VBScript)'The following example clicks the right mouse button on the Button20-01 object. Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUIButton("Button20-01").RightClick
Search Method
Description
Enters the specified text in the Search edit box and clicks the Search button.
Syntax
object.Search Text
Arguments
| Parameter | Description |
|---|---|
| Text |
Required. A String value. The text to enter in the search box. |
Return Type
None
IMPORTANT
- This method is relevant only for an edit control that functions as a search box.
- If your application displays an alert box after pressing the Search button, UFT One does not display the search alert box when running this method.
Example
Run a Search for a Specific String (VBScript)'The following example searches for a text string by entering the string and pressing the search button Browser("SAPUI5 SDK").Page("SAPUI5 SDK").Frame("content").SAPUITextEdit("simpleSearch").Search "aaa"
Set Method
Description
Enters the specified text in the edit box .
Syntax
object.Set Text
Arguments
| Parameter | Description |
|---|---|
| Text |
Required. A String value. The text that is entered in the edit box. The text replaces any text that was there previously. |
Return Type
None
IMPORTANT
If you press the ENTER key after entering a string in a TextEdit object, UFT One records this method instead of the Submit method. If you need an additional Submit method, manually enter a Submit statement after this method.
Example
Set the Text in a Text Edit Field (VBScript)'The following example sets the text for the text edit field Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUITextEdit("VHF5-input").Set "help + F4"
Open an AutoComplete List and Select an Item (VBScript)'The following example types a letter in an autocomplete text box 'and then selects a specific item from the list that opens. Browser("SAPUI5 SDK").Page("SAPUI5 SDK").Frame("content").SAPUITextEdit("liveSearch").Set "b" Browser("SAPUI5 SDK").Page("SAPUI5 SDK").Frame("content").SAPUIList("SAPUIList").Select "Belarus"
SetSecure Method
Description
Sets the encrypted value of an edit box.
Syntax
object.SetSecure EncryptedText
Arguments
| Parameter | Description |
|---|---|
| EncryptedText |
Required. A String value. The encrypted text to be entered in the edit field. |
Return Type
None
IMPORTANT
The SetSecure method is recorded when a password or other secure text is entered. The text is encrypted while recording, and decrypted during the test run.
To find the encoded value to use as the argument for the this method, do one of the following:
Use the Password Encoder utility (available from the Windows Start menu).
- Parameterize the argument using a Data Table parameter and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt).
For more information, refer to the UFT One User Guide.
While the SetSecure method enables you to hide passwords on the screen when running a test, it is not intended to be a secure way to protect password information.
Example
Encrypt a String to Enter into the Text Edit Field (VBScript)'The following example encrypts a text string to be entered into the text edit field Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUITextEdit("liveSearch-tf-input").SetSecure "5378a8418674d385ac7b818df64c4bbfee742dfbaeff6246"
Submit Method
Description
Submits a form.
Syntax
object.Submit
Return Type
None
IMPORTANT
If you press the ENTER key after entering a string in a TextEdit object, UFT One does not record this method. If you need an additional Submit step, manually enter a Submit statement.
Swipe Method
Description
Swipes the object.
Syntax
object.Swipe direction, [distance], [duration], [startX], [startY]
Arguments
| Parameter | Description |
|---|---|
| direction |
Required. A MoveDirection Value. The direction of the swipe gesture. Possible values:
|
| distance |
Optional. An integer value. The distance (in pixels) of the swipe gesture. Default value = 0 |
| duration |
Optional. A Variant. The time period (in seconds) of the swipe gesture. You can specify partial seconds as a duration time. |
| startX |
Optional. An integer value. The x-coordinate at which the swipe gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object. Default value = 0 |
| startY |
Optional. An integer value. The time period (in seconds) of the swipe gesture. You can specify partial seconds as a duration time. Default value = 0 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported for Windows Phone.
Example
Swipe a Text Edit Field (VBScript)'The following example performs a Swipe gesture on an SAPUITextEdit object. Browser("SAPUI5 SDK - Demo Kit").Page("SAPUI5 SDK - Demo Kit").Frame("content").SAPUITextEdit("VHF1-input").Swipe moveDown,200,1,75,75
See also:
- SAPUIAccordion
- SAPUIButton
- SAPUICalendar
- SAPUICarousel
- SAPUICheckBox
- SAPUIDatePicker
- SAPUIDateTimeInput
- SAPUIDialog
- SAPUIFacetFilter
- SAPUIHeader
- SAPUILabel
- SAPUIList
- SAPUIMenu
- SAPUIMenubar
- SAPUINavigationBar
- SAPUINotificationBar
- SAPUIPaginator
- SAPUIPassword
- SAPUIRadioButton
- SAPUIRadioGroup
- SAPUIRatingIndicator
- SAPUIRoadMap
- SAPUIRowRepeater
- SAPUITable
- SAPUITabStrip
- SAPUITextEdit
- SAPUITile
- SAPUIToggleButton
- SAPUIToolbar
- SAPUITree
