AcxTable Object
Description
An ActiveX table.
IMPORTANT
For details on the supported ActiveX grid controls and versions, see the OpenText Functional Testing Support Matrix.
Operations
The sections below list the built-in methods and properties that you can use as operations for the AcxTable object.
Note: You can also view a list and descriptions of the AcxTable 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
ActivateCell | Activates (double-clicks) the specified cell in the table. |
ActivateColumn | Activates (double-clicks) the specified column in the table. |
ActivateRow | Activates (double-clicks) the specified row in the table. |
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. |
GetCellData | Retrieves the contents of the specified cell from the table. |
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. |
MakeCellVisible | Scrolls the specified cell into view if it is not visible in the table. |
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 OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
SelectCell | Selects (clicks) the specified cell in the table. |
SelectColumn | Selects (clicks) the specified column in the table. |
SelectRow | Selects (clicks) the specified row in the table. |
SetCellData | Sets the contents of a cell to the specified text. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ToString | Returns a string that represents the test object. |
Type | Types the specified string in the ActiveX object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
ColumnCount | Returns the number of columns in the table. |
Exist | Checks whether the object currently exists in the open application. |
Object | Accesses the native methods and properties of the ActiveX object. |
RowCount | Returns the number of rows in the table. |
ActivateCell Method
Description
Activates (double-clicks) the specified cell in the table.
Syntax
object.ActivateCell (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell you want to activate. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell you want to activate. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Return Type
None.
Example
'The following example uses the ActivateCell method to double click 'the third row and 1st column in the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").ActivateCell 3, 1
ActivateColumn Method
Description
Activates (double-clicks) the specified column in the table.
Syntax
object.ActivateColumn (Column)
Arguments
Parameter | Description |
---|---|
Column |
Required. A Variant. The name or 0-based index of the column you want to activate. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Return Type
None.
Example
'The following example uses the ActivateColumn method to double click 'the third column in the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").ActivateColumn 3
ActivateRow Method
Description
Activates (double-clicks) the specified row in the table.
Syntax
object.ActivateRow (Row)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row you want to activate. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Return Type
None.
Example
'The following example uses the ActivateRow method to double click 'the third row in the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").ActivateRow 3
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
'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
'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
'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
'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
'The following example uses the FireEvent method to simulate a 'click event on the Save button. Browser("Homepage").Page("Welcome").AcxButton("Save").FireEvent "Click"
GetCellData Method
Description
Retrieves the contents of the specified cell from the table.
Syntax
object.GetCellData (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell whose data you want to retrieve. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell whose data you want to retrieve. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Return Type
A String value.
Example
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 OpenText Functional Testing 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 OpenText Functional Testing 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
'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 OpenText Functional Testing 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 OpenText Functional Testing 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
'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 If
'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
MakeCellVisible Method
Description
Scrolls the specified cell into view if it is not visible in the table.
Syntax
object.MakeCellVisible (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell you want to make visible. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell you want to make visible. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Return Type
None.
IMPORTANT
This method is supported only for Microsoft Grid, and Microsoft Flex Grid.
(For exact supported versions of these grids, see the OpenText Functional Testing Support Matrix.
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
'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
'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
SelectCell Method
Description
Selects (clicks) the specified cell in the table.
Syntax
object.SelectCell (Row, Column)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell you want to select. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell you want to select. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Return Type
None.
Example
'The following example uses the SelectCell method to click the third 'row and first column in the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").SelectCell 3, 1
SelectColumn Method
Description
Selects (clicks) the specified column in the table.
Syntax
object.SelectColumn (Column)
Arguments
Parameter | Description |
---|---|
Column |
Required. A Variant. The name or 0-based index of the column you want to select. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Return Type
None.
Example
'The following example uses the SelectColumn method to click the 'first column in the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").SelectColumn 1
SelectRow Method
Description
Selects (clicks) the specified row in the table.
Syntax
object.SelectRow (Row)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row you want to select. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Return Type
None.
Example
'The following example uses the SelectRow method to click the third row 'in the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").SelectRow 3
SetCellData Method
Description
Sets the contents of a cell to the specified text.
Syntax
object.SetCellData (Row, Column, Data)
Arguments
Parameter | Description |
---|---|
Row |
Required. A Variant. The 0-based index of the row containing the cell data you want to set. The index value is recorded in the format "#N" where N is the 0-based row index. When entering the argument value manually, you can use any of the following string or number formats: "#N", "N", or N. |
Column |
Required. A Variant. The name or 0-based index of the column containing the cell whose data you want to set. The column value is recorded in the format "#N" where N is the 0-based column index. When entering the argument value manually, you can use any of the following string or number formats: "ColumnName", "#N", "N", or N. |
Data |
Required. A String value. The contents to be entered into the specified cell. |
Return Type
None.
Example
'The following example uses the SetCellData method to enter the text 'hello into the third row and first column of the MSFlexGrid table. Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").SetCellData 3, 1, "Hello"
Type Method
Description
Types the specified string in the ActiveX object.
Syntax
object.Type KeyboardInput
Arguments
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
KeyboardInput |
Required. A String value. The text string and/or constants representing non-alphanumeric keys. The following constants are available:
|
Return Type
None
IMPORTANT
Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.
Example
'The following example uses the Type method to type "ABC" in the 'AcxTable object. Browser("Homepage").Page("Welcome").AcxTable("MSFlexGrid").Type "ABC"
ColumnCount Property
Description
Returns the number of columns in the table.
Syntax
object.ColumnCount
Value Type
An integer value.
Property type
Read-only property
Example
'The following example uses the ColumCount method to return the number 'of columns in the MSFlexGrid table and displays the number in a 'message box. Columns = Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").ColumnCount MsgBox Columns
RowCount Property
Description
Returns the number of rows in the table.
Syntax
object.RowCount
Value Type
A long integer value.
Property type
Read-only property
IMPORTANT
This property is not supported for Microsoft DataBound Grid tables.
Example
'The following example uses the RowCount method to return the number 'of rows in the MSFlexGrid table and displays the number in a message 'box. Rows = Browser("Company").Page("FlexGridDemo").AcxTable("MSFlexGrid").RowCount MsgBox Rows
See also: