Share this page
AcxEdit Object
Description
An ActiveX edit box.
Operations
The sections below list the built-in methods and properties that you can use as operations for the AcxEdit object.
Note: You can also view a list and descriptions of the AcxEdit 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 an ActiveX object. |
| DblClick | Double-clicks an ActiveX object. |
| Drag | Performs the 'drag' part of a drag and drop operation. |
| Drop | Performs the 'drop' part of a drag and drop operation. |
| FireEvent | Simulates an event on the ActiveX object. |
| GetROProperty | Returns the current value of the description property from the object in the application. |
| GetTextLocation | Checks whether the specified text string is contained in the specified window area. |
| 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. |
| GetVisibleText | Returns the text from the specified area. |
| MakeVisible | Scrolls an ActiveX object into view if it is not visible in the window. |
| MouseMove | Moves the mouse pointer to the designated position inside the ActiveX object. |
| 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 value of the edit box. |
| SetCaretPos | Places the cursor at the specified column in the edit box. |
| SetSecure | Sets the encrypted value of the edit box. |
| SetSelection | Selects the specified text in the edit box. |
| 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 ActiveX object. |
Click Method
Description
Clicks an ActiveX 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 = -9999 |
| 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.
Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to click the object. Default value = micLeftBtn |
Return Type
None
Example
Click an ActiveX Object (VBScript)
'The following example uses the Click method to click a
'"Flight Reservations" AcxTable object at coordinates 20, 10.
Browser("Flight").Page("Flight").AcxTable("Flight Reservations").Click 20, 10
DblClick Method
Description
Double-clicks an ActiveX object.
Syntax
object.DblClick X, Y, [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| X |
Required. An integer value. The x-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object. |
| Y |
Required. An integer value. The y-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object. |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to double-click the object. Default value = micLeftBtn |
Return Type
None
Example
Double-Click an ActiveX Object (VBScript)
'The following example uses the DblClick method to double-click a
'"Calendar" ActiveX object at coordinates 73, 120.
Browser("Flight").Page("Flight").ActiveX("Calendar").DblClick 73, 120, 1
Drag Method
Description
Performs the 'drag' part of a drag and drop operation.
Syntax
object.Drag X, Y, [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| X |
Required. An integer value. The x-coordinate within the object from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object. |
| Y |
Required. An integer value. The y-coordinate within the object from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object. |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to drag the object. Default value = micLeftBtn |
Return Type
None
Example
Drag an ActiveX Object to a New Location (VBScript)
'The following example uses the Drag method to drag and drop an
'ActiveX "Calendar"object.
Browser("Flight").Page("Flight").ActiveX("Calendar").Drag 10, 20
Browser("Flight").Page("Flight").ActiveX("Calendar").Drop 30, 40
Drop Method
Description
Performs the 'drop' part of a drag and drop operation.
Syntax
object.Drop X, Y, [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| X |
Required. An integer value. The x-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object. |
| Y |
Required. An integer value. The y-coordinate of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object. |
| BUTTON |
Optional. A predefined constant or number. The button is released in order to drop the object. Default value = micLeftBtn |
Return Type
None
Example
Drop an ActiveX Object in a New Location (VBScript)
'The following example uses the Drop method to drag and drop an
'AcxButton Calendar object.
Browser("Flight").Page("Flight").AcxButton("Calendar").Drag 10, 20
Browser("Flight").Page("Flight").AcxButton("Calendar").Drop 30, 40
FireEvent Method
Description
Simulates an event on the ActiveX object.
Syntax
object.FireEvent EventName
Arguments
| Parameter | Description |
|---|---|
| EventName |
Required. A Variant. The name of the event to simulate. The list of possible events depends on the object. |
|
Required. None Zero or more arguments of the event. The list of arguments depends on the EventName. |
Return Type
None
IMPORTANT
The event is sent to the container of the ActiveX object and does not affect the ActiveX object itself. For example, simulating a click event does not actually perform the click.
Example
Fire an Event on a Button (VBScript)
'The following example uses the FireEvent method to simulate a
'click event on the Save button.
Browser("Homepage").Page("Welcome").AcxButton("Save").FireEvent "Click"
GetTextLocation Method
Description
Checks whether the specified text string is contained in the specified window area.
Syntax
object.GetTextLocation (TextToFind, Left, Top, Right, Bottom, [MatchWholeWordOnly])
Arguments
| Parameter | Description |
|---|---|
| TextToFind |
Required. A String value. The text string you want to locate. |
| Left |
Required. A Variant. The left coordinate of the search area within the window or screen, as a long integer. |
| Top |
Required. A Variant. The top coordinate of the search area within the window or screen, as a long integer. |
| Right |
Required. A Variant. The right coordinate of the search area within the window or screen, as a long integer. |
| Bottom |
Required. A Variant. The bottom coordinate of the search area within the window or screen, as a long integer. Note: Set the Left, Top, Right, and Bottom coordinates to -1 to search for the text string within the object's entire window. |
| MatchWholeWordOnly |
Optional. A Boolean value. If True, the method searches for occurrences that are whole words only and not part of a larger word. If False, the method does not restrict the results to occurrences that are whole words only. Default value = True |
Return Type
A Boolean value.
This method returns the coordinates of the rectangle containing the first instance of the text into the Left, Top, Right, and Bottom arguments if the text is found.
IMPORTANT
- The text to capture must be visible in the application window when the step runs.
- This method returns True only if the TextToFind argument value is found within a single line in the specified area. The text search restarts on each line of text.
- If the TextToFind argument value includes a space, then this method searches for that text as whole words, regardless of the value set in the MatchWholeWords argument. For example, if you search for "a b" and the text "bla bla" exists, the method will still return False. However, if the MatchWholeWords argument is set to False, then a search for "la" in an area where "bla bla" exists, would return True.
- If the text is found (return value = True) and if the Left, Top, Right, and Bottom arguments are supplied as variables, then the method also returns the exact coordinates of the specified text to the supplied arguments (the returned coordinates overwrite the supplied ones).
- The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition pane).
- The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetTextLocation method.
- By default, when UFT One captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If UFT One cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).
Example
Retrieve All Text Within an ActiveX Object (VBScript)
'The following example uses the GetTextLocation method to retrieve
'all of the text within the object.
l = -1
t = -1
r = -1
b = -1
result = Window("Date").ActiveX("Calendar").GetTextLocation("2002", l, t, r, b)
If result Then
MsgBox "Text found. Coordinates:" & l & "," & t & "," & r & "," & b
End If
GetVisibleText Method
Description
Returns the text from the specified area.
Syntax
object.GetVisibleText ([Left], [Top], [Right], [Bottom])
Arguments
| Parameter | Description |
|---|---|
| Left |
Optional. A long integer value. The left coordinate of the search area within the object's window. Default value = -1 |
| Top |
Optional. A long integer value. The top coordinate of the search area the object's window. Default value = -1 |
| Right |
Optional. A long integer value. The right coordinate of the search area within the object's window. Default value = -1 |
| Bottom |
Optional. A long integer value. The bottom coordinate of the search area a within the object's window. Note: If the Left, Top, Right, and Bottom arguments are not specified, the method returns all of the text within the visible part of the specified object. Default value = -1 |
Return Type
A String value.
IMPORTANT
- The text to capture must be visible in the application window when the step runs.
- The area is defined by pairs of coordinates that designate two diagonally opposite corners of a rectangle.
- The results of this method may be different depending on the settings selected in the Text Recognition pane of the Options dialog box (Tools menu > Options item > GUI Testing tab > Text Recognition pane).
- The results of this method may be different in different run sessions depending on the operating system version you are using, service packs you have installed, other installed toolkits, or the APIs used in your application. Therefore, when possible, it is highly recommended to use the GetROProperty Method to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.
- By default, when UFT One captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If UFT One cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).
Example
Retrieve All the Text from a Table (VBScript)
'The following example uses the GetVisibleText method to retrieve
'the text from the "MSFlexGrid" table. If the returned string contains
'the "login:" sub-string, the Type method is used to type the
'"guest" string in the window.
TestText = Browser("Homepage").Page("Welcome").AcxTable("MSFlexGrid").GetVisibleText
If InStr(1, TestText, "login:", 1) > 0 Then
Browser("Homepage").Page("Welcome").AcxTable("MSFlexGrid").Type "guest"
End IfRetrieve Text From Specified Coordinates within an ActiveX Object (VBScript)
'The following example uses the GetVisibleText method to retrieve
'the text within the specified coordinates. If the returned string
'is not Month, the ReportEvent method is used to report a failed step.
theText = Window("Date").ActiveX("Calendar").GetVisibleText(16, 25, 56, 92)
If theText <> "Month" Then
Reporter.ReportEvent micFail, "Traders", "Text check failed"
End If
MakeVisible Method
Description
Scrolls an ActiveX object into view if it is not visible in the window.
Syntax
object.MakeVisible
Return Type
None
IMPORTANT
This method is supported only when working with ActiveX controls inside a Web browser.
Example
Bring a Radio Button into View on the Screen (VBScript)
'The following example uses the MakeVisible method to bring the
'CIRC3 AcxRadioButton into view.
Browser("Welcome to A-Soft").Page("Untitled Normal").AcxRadioButton("CIRC3.Circ3Ctrl.1").MakeVisible
MouseMove Method
Description
Moves the mouse pointer to the designated position inside the ActiveX object.
Syntax
object.MouseMove X, Y
Arguments
| Parameter | Description |
|---|---|
| X |
Required. An integer value. The x-coordinate of the mouse pointer, relative to the upper left corner of the object. |
| Y |
Required. An integer value. The y-coordinate of the mouse pointer, relative to the upper left corner of the object. |
Return Type
None
Example
Move the Mouse to a Specified Location on an ActiveX Object (VBScript)
'The following example uses the MouseMove method to move the
'mouse pointer to the top left corner of the "Calendar" object:
Window("Date").ActiveX("Calendar").MouseMove 0, 0
Set Method
Description
Sets the value of the edit box.
Syntax
object.Set Text
Arguments
| Parameter | Description |
|---|---|
| Text |
Required. A String value. The text to be entered in the edit field. |
Return Type
None
Example
Enter Text in an Edit Box (VBScript)
'The following example uses the Set method to set the file name
'document.txt in the File name edit box.
Dialog("Open").AcxEdit("File &name:").Set "document.txt"
SetCaretPos Method
Description
Places the cursor at the specified column in the edit box.
Syntax
object.SetCaretPos Column
Arguments
| Parameter | Description |
|---|---|
| Column |
Required. An integer value. The zero-based column position (in characters) at which the insertion point is placed. |
Return Type
None
Example
Type a Letter in a Specific Position in an Edit Box (VBScript)
'The following example uses the SetCaretPos method to type the text, "a
'example" in an edit box, and then adds an "n" to correct the text
'to say "an example".
Dialog("Edit").AcxEdit("MyEdit").SetCaretPos 0
Dialog("Edit").AcxEdit("MyEdit").Type "a example"
Dialog("Edit").AcxEdit("MyEdit").SetCaretPos 1
Dialog("Edit").AcxEdit("MyEdit").Type "n"
SetSecure Method
Description
Sets the encrypted value of the edit box.
Syntax
object.SetSecure Text
Arguments
| Parameter | Description |
|---|---|
| Text |
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. 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
Enter an Encrypted Password in a Password Box (VBScript)
'The following example uses the SetSecure method to set a password in
'"Enter password" dialog box.
Dialog("Enter password").AcxEdit("Password:").SetSecure "cvrt55ccrf5656edsd"
SetSelection Method
Description
Selects the specified text in the edit box.
Syntax
object.SetSelection ColumnFrom, ColumnTo
Arguments
| Parameter | Description |
|---|---|
| ColumnFrom |
Required. An integer value. The column at which the selection starts (in characters). |
| ColumnTo |
Required. An integer value. The column at which the selection ends (in characters). |
Return Type
None
Example
Highlight Text in an Edit Box (VBScript)
'The following example uses the SetSelection method to mark a selection
'of text in an edit box (the second character to the fifth character
'inclusive)
Dialog("Edit").AcxEdit("Position").SetSelection 1, 4
See also:
