Object Model Reference for GUI Testing > .NET Windows Forms > Activate Method

SwfListView Object

Description

A .NET Windows Forms ListView control.

IMPORTANT

You can check or output both the content and properties of a SwfListView object. For example, you can check that a specified value is displayed in a certain cell or retrieve the value located in a certain cell. You can also check that the object has the expected number of rows and columns.

When you insert a standard checkpoint or output value on a SwfListView object, the Define Row Range dialog box opens, enabling you to select the range of rows you want to include in your checkpoint or output value step. After you define the row range, the Table Checkpoint Properties or Table Output Value Properties dialog box opens, enabling you to check or output the content and properties of your SwfListView object (instead of just the properties, as in standard checkpoints and output values).

Operations

The sections below list the built-in methods and properties that you can use as operations for the SwfListView object.

Note: You can also view a list and descriptions of the SwfListView 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

Method Activate Activates (double-clicks) an item in the list.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks an object.
Method ColumnCount Returns the number of columns in a ListView object.
Method DblClick Double-clicks an object
Method Deselect Deselects an item in the list.
Method Drag Performs the 'drag' part of a drag-and-drop operation.
Method DragItem Performs the 'drag' part of a drag-and-drop operation.
Method Drop Performs the 'drop' part of a drag-and-drop operation.
Method DropOnItem Performs the 'drop' part of a drag-and-drop operation by dropping the item onto a specified target item.
Method EditLabel Activates the edit mode for an object list item for the purpose of renaming it.
Method ExtendSelect Selects an additional item from a multi-selection list.
Method FireEvent Simulates an event on a .NET object.
Method GetCheckMarks Retrieves a string containing the indexes of the selected items, separated by a semicolon (;).
Method GetColumnHeader Returns the text header of a (report-style) ListView column.
Method GetContent Returns all of the items in the list.
Method GetErrorProviderText Returns the tooltip text of the error icon associated with the object.
Method GetItem Returns the value of the item specified by the index.
Method GetItemProperty Returns the current value of a property for an item in the ListView list.
Method GetItemsCount Returns the number of items in the list.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetSelection Returns all of the selected items in the list.
Method GetSubItem Returns the text value of a report-style (LVS_REPORT) ListView subitem.
Method GetTextLocation Checks whether the specified text string is contained in the specified window area.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method GetVisibleText Returns the text from the specified area.
Method MouseMove Moves the mouse pointer to the designated position over the object.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method Select Selects an item from the list.
Method SelectRange Selects all list items between (and including) two specified items.
Method SetItemState Sets the state of the check box for a specified ListView item.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Common Method ToString Returns a string that represents the test object.
Method Type Types the specified string in the object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

 

Back to top

Activate Method

Description

Activates (double-clicks) an item in the list.

Syntax

object.Activate Item, [BUTTON]

Arguments

Parameter Description
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

Click Method

Description

Clicks an 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.
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 = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

ColumnCount Method

Description

Returns the number of columns in a ListView object.

Syntax

object.ColumnCount

Return Type

A long integer value.

IMPORTANT

If you perform this method on a non-report-style list, it is always treated as a list with a single column, and the value 1 is returned.

Example


 

Back to top

DblClick Method

Description

Double-clicks an 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


 

Back to top

Deselect Method

Description

Deselects an item in the list.

Syntax

object.Deselect Item

Arguments

Parameter Description
Item Required. A Variant.
The item to deselect from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

None

IMPORTANT

The object's SelectionMode property must be set to Multiple.

Example


 

Back to top

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 coordinates within the window 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 coordinates within the window 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


 

Back to top

DragItem Method

Description

Performs the 'drag' part of a drag-and-drop operation.

Syntax

object.DragItem (Item, [BUTTON])

Arguments

Parameter Description
Item Required. A Variant.
The list-view control item to drag. The logical name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the list-view control.

Note: The same button must be used in both the DragItem and DropOnItem parts of the drag and drop operation.


Default value = micLeftBtn

Return Type

None.

IMPORTANT

A DragItem statement must be followed by a Drop or DropOnItem statement.

Example


 

Back to top

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 coordinates 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 coordinates 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 that is released to drop the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

DropOnItem Method

Description

Performs the 'drop' part of a drag-and-drop operation by dropping the item onto a specified target item.

Syntax

object.DropOnItem (TargetItem, [BUTTON])

Arguments

Parameter Description
TargetItem Required. A Variant.
The list-view control item on which to drop the dragged list-view control item. The logical name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Note: The same button must be used in both the DragItem and DropOnItem parts of the drag and drop operation.
Default value = micLeftBtn

Return Type

None.

IMPORTANT

A DropOnItem statement must be preceded by a Drag or DragItem statement.

Example


 

Back to top

EditLabel Method

Description

Activates the edit mode for an object list item for the purpose of renaming it.

Syntax

object.EditLabel (Item)

Arguments

Parameter Description
Item Required. A Variant.

The list-view control item to edit. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

None.

IMPORTANT

This method only enables the item for renaming. To actually rename the item, you must set its value using the WinEdit or WinEditor test object, together with an applicable method, such as Set or SetCaretPos+Type.

Example


 

Back to top

ExtendSelect Method

Description

Selects an additional item from a multi-selection list.

Syntax

object.ExtendSelect Item

Arguments

Parameter Description
Item Required. A Variant.
The item to select from the list-view control. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

None

Example


 

Back to top

FireEvent Method

Description

Simulates an event on a .NET 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
The Args argument is passed to the constructor of the event's EventArgs object or the implementing class. Enter the values in a comma separated list. If no event arguments are required, you do not need to supply a value for the argument.

Return Type

None.

IMPORTANT

The event is sent to all listeners of the .NET object and does not affect the .NET object itself. For example, simulating a click event does not actually perform the click.

Example


 

Back to top

GetCheckMarks Method

Description

Retrieves a string containing the indexes of the selected items, separated by a semicolon (;).

Syntax

object.GetCheckMarks

Return Type

A String value.

IMPORTANT

You can use this method only for list-view controls with 1000 or fewer items.

Example


 

Back to top

GetColumnHeader Method

Description

Returns the text header of a (report-style) ListView column.

Syntax

object.GetColumnHeader (Column)

Arguments

Parameter Description
Column Required. A Variant.
The list-view control column whose header text you want to retrieve.

Return Type

A String value.

Example


 

Back to top

GetContent Method

Description

Returns all of the items in the list.

Syntax

object.GetContent

Return Type

A String value.

IMPORTANT

The returned string contains all of the items in the list-view control separated by line feed characters.

You can use this method only for list-view controls with 1000 or fewer items.

Example


 

Back to top

GetErrorProviderText Method

Description

Returns the tooltip text of the error icon associated with the object.

Syntax

object.GetErrorProviderText

Return Type

A String value.

If no error provider control currently exists for the object, the method returns an empty string.

Example


 

Back to top

GetItem Method

Description

Returns the value of the item specified by the index.

Syntax

object.GetItem (Index)

Arguments

Parameter Description
Index Required. A Variant.

The item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Return Type

A String value.

Example


 

Back to top

GetItemProperty Method

Description

Returns the current value of a property for an item in the ListView list.

Syntax

object.GetItemProperty (Item, Property)

Arguments

Parameter Description
Item Required. A Variant.

The item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a list-view control is numbered 0.

Property Required. A String value.
Property to retrieve from the item in the object's list. See the table below for a list of supported properties.

The following properties are supported:

Property Name
Description
focused
Indicates whether the list-view control has the focus.
Possible values:        
       True
       False
ImageIndex
The image list index of the image (icon) associated with the list item.
OverlayImage
The image list index of the overlay image (transparent image displayed over the regular item image) associated with the list item.
selected
Indicates whether the list-view control is selected.
Possible values:                                    
       True
       False
state
The current state of the check box (only available for nodes with check boxes). State is an image list index between 0 and 11 that refers to a specific image used to indicate a specific state.
text
The text of the list-view control, or "" if the list-view control does not contain any text.

Return Type

A Variant.

Example


 

Back to top

GetItemsCount Method

Description

Returns the number of items in the list.

Syntax

object.GetItemsCount

Return Type

A long integer value.

Example


 

Back to top

GetSelection Method

Description

Returns all of the selected items in the list.

Syntax

object.GetSelection

Return Type

A String value.

IMPORTANT

The returned string contains all of the selected items in the list separated by line feed characters.

You can use this method only for lists with 1000 or fewer items.

Example


 

Back to top

GetSubItem Method

Description

Returns the text value of a report-style (LVS_REPORT) ListView subitem.

Syntax

object.GetSubItem (Item, [SubItem])

Arguments

Parameter Description
Item Required. A Variant.

Name or numeric index of the item. Index values begin with 0.

SubItem Optional. A Variant.
Column name or numeric index of the subitem. Index values begin with 0.

Default value = 0

Return Type

A String value.

Example


 

Back to top

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.
Top Required. A Variant.
The top coordinate of the search area within the window or screen.
Right Required. A Variant.
The right coordinate of the search area within the window or screen.
Bottom Required. A Variant.
The bottom coordinate of the search area within the window or screen.

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

Default value = True

Return Type

A Boolean value.

Indicates whether the text was found in the specified coordinates. Additionally, if the text is found, this method returns the coordinates of the rectangle containing the first instance of the text into the Left, Top, Right, and Bottom arguments.

IMPORTANT

Example


 

Back to top

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

Example


 

Back to top

MouseMove Method

Description

Moves the mouse pointer to the designated position over the object.

Syntax

object.MouseMove X, Y

Arguments

Parameter Description
X Required. An integer value.
The position of the mouse pointer, expressed as x-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The position of the mouse pointer, expressed as y-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.

Return Type

None

IMPORTANT

The MouseMove method may behave unexpectedly in a VMware environment.

Workaround: Add the following line to the VMware configuration file (<VM name>.vmx): vmmouse.present = "FALSE"
For more information, refer to the VMware support article, number 1691 - "Unexpected Cursor Behavior in Windows Virtual Machine with "Snap To" Mouse Control Panel Option Enabled", at: http://www.vmware.com/support/kb/enduser/std_alp.php.

Example


 

Back to top

Select Method

Description

Selects an item from the list.

Syntax

object.Select Item, [BUTTON], [Offset]

Arguments

Parameter Description
Item Required. A Variant.
The item to select from the list. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn
Offset Optional. An integer value.
The horizontal offset (in pixels) of the click location relative to the left margin of the item's text. This argument can be used only if the BUTTON argument is defined. The default value is the center of the object.
Default value = -1

Return Type

None

Example


 

Back to top

SelectRange Method

Description

Selects all list items between (and including) two specified items.

Syntax

object.SelectRange Item, [ItemTo]

Arguments

Parameter Description
Item Required. A Variant.
One of the items in the range. If the ItemTo argument is not specified, then the Item is one end of the range and the currently selected item is the other end of the range.  If the ItemTo argument is specified, then Item is the first item in the range.
The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.
ItemTo Optional. A Variant.
The last item of the range.
The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.

Return Type

None

IMPORTANT

This method is applicable only to lists that allow multiple selection.

Note: The order of the two items is unimportant. Item can be located above or below ItemTo (or the currently selected item).

Example


 

Back to top

SetItemState Method

Description

Sets the state of the check box for a specified ListView item.

Syntax

object.SetItemState Item, State

Arguments

Parameter Description
Item Required. A Variant.
The item whose check box you want to set. The item value (with quotes) or numeric index (without quotes) can denote the item. The first item in a list is numbered 0.
State Required. An integer value.
The object's state. The state can either be an index, or one of the following state constants:
micChecked (1)--Selects the item's check box.
micUnchecked (0)--Clears the item's check box.
micClick (-1)--Clicks the state icon.
micDblClick (-2)--Double-clicks the state icon.

Return Type

None

Example


 

Back to top

Type Method

Description

Types the specified string in the 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:
Constant
Action
micCtrlDwn
Presses the Ctrl key.
micCtrlUp
Releases the Ctrl key.
micLCtrlDwn
Presses the left Ctrl key.
micLCtrlUp
Releases the left Ctrl key.
micRCtrlDwn
Presses the right Ctrl key.
micRCtrlUp
Releases the right Ctrl key.
micAltDwn
Presses the Alt key.
micAltUp
Releases the Alt key.
micLAltDwn
Presses the left Alt key.
micLAltUp
Releases the left Alt key.
micRAltDwn
Presses the right Alt key.
micRAltUp
Releases the right Alt key.
micShiftDwn
Presses the Shift key.
micShiftUp
Releases the Shift key.
micLShiftDwn
Presses the left Shift key.
micLShiftUp
Releases the left Shift key.
micRShiftDwn
Presses the right Shift key.
micRShiftUp
Releases the right Shift key.
micIns
Presses the Insert key.
micDel
Presses the Delete key.
micHome
Presses the Home key.
micEnd
Presses the End key.
micPgUp
Presses the Page Up key.
micPgDwn
Presses the Page Down key.
micUp
Presses the Up Arrow key.
micDwn
Presses the Down Arrow key.
micLeft
Presses the Left Arrow key.
micRight
Presses the Right Arrow key.
micEsc
Presses the Esc key.
micBack
Presses the Backspace key.
micReturn
Presses the Return key.
micTab
Presses the Tab key.
micBreak
Presses the Break key.
micPause
Presses the Pause key.
micPrintScr
Presses the Print Screen key.
micWinLogoDwn
Presses the Windows Logo key.
micWinLogoUp
Releases the Windows Logo key.
micLWinLogoDwn
Presses the left Windows Logo key.
micLWinLogoUp
Releases the left Windows Logo key.
micRWinLogoDwn
Presses the right Windows Logo key.
micRWinLogoUp
Releases the right Windows Logo key.
micAppKey
Presses the Application key.
micF1
Presses the F1 key.
micF2
Presses the F2 key.
micF3
Presses the F3 key.
micF4
Presses the F4 key.
micF5
Presses the F5 key.
micF6
Presses the F6 key.
micF7
Presses the F7 key.
micF8
Presses the F8 key.
micF9
Presses the F9 key.
micF10
Presses the F10 key.
micF11
Presses the F11 key.
micF12
Presses the F12 key.
micNumLockOn
Turns on the Num Lock.
micCapsLockOn
Turns on the Caps Lock.
micScrollOn
Turns on the Scroll Lock.
micNumLockOff
Turns off the Num Lock.
micCapsLockOff
Turns off the Caps Lock.
micScrollOff
Turns off the Scroll Lock.

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


Back to top

See also: