Object Model Reference for GUI Testing > Stingray > Activate Method

WinTreeView Object

Description

A Stingray tree control.

Operations

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

Note: You can also view a list and descriptions of the WinTreeView 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) a node in the tree view.
Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
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 Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Method Click Clicks an object in a Stingray grid.
Method Collapse Hides sub-nodes of the specified node in the expanded tree view.
Method DblClick Double-clicks an object in a Stingray grid.
Method Deselect Deselects a tree control.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method DragItem Performs the 'drag' part of a drag and drop operation on a specified node in a tree.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method DropOnItem Completes the drag and drop operation by dropping the node onto a specified target node.
Method EditLabel Activates the edit mode for a node in the tree view to enable renaming.
Method Expand Displays hidden sub-nodes of the specified node in the tree view.
Method ExtendSelect Selects an additional item.
Method GetCheckMarks Retrieves the value of items marked as checked.
Method GetContent Returns all of the nodes in the tree view.
Method GetItem Returns the value of the node specified by the index.
Method GetItemIndex Returns the index of a tree control.
Method GetItemProperty Returns the current value of a property for a node in the tree view.
Method GetItemsCount Returns the number of nodes in the tree view.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetSelection Returns all of the selected nodes in the tree view.
Method GetSubItem Returns the Column value of a tree control.
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 inside the object.
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 a node in the tree view.
Method SetItemState Sets the state of the check box icon of the specified node in the tree view.
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.

 

Back to top

Activate Method

Description

Activates (double-clicks) a node in the tree view.

Syntax

object.Activate Item

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node to activate in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

Return Type

None

Example


 

Back to top

Click Method

Description

Clicks an object in a Stingray grid.

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 (-9999) 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. micNoCoordinate indicates 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


 

Back to top

Collapse Method

Description

Hides sub-nodes of the specified node in the expanded tree view.

Syntax

object.Collapse Item

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node to collapse in the tree-view control. The node value (with quotes) or numeric index (without quotes) can denote the node. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. 

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

Return Type

None

Example


 

Back to top

DblClick Method

Description

Double-clicks an object in a Stingray grid.

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


 

Back to top

Deselect Method

Description

Deselects a tree control.

Syntax

object.Deselect Item

Arguments

Parameter Description
Item Required. A Variant.
The full path of the node whose check box you want to deselect. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Return Type

None

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 x-coordinate 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 y-coordinate 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 Required. A predefined constant or number.
The mouse button used to drag the object.

Return Type

None


 

Back to top

DragItem Method

Description

Performs the 'drag' part of a drag and drop operation on a specified node in a tree.

Syntax

object.DragItem Item, [BUTTON]

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node to drag in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0. 

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

BUTTON Optional. An integer value.
A pre-defined constant or number. See the Constants table, below. The mouse button used to drag the node. 
Note: The same button must be used in both the DragItem and DropOnItem parts of the drag and drop operation.
Default value = 0

Return Type

None

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 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 Required. A predefined constant or number.
The mouse button that is released to drop the object.

Return Type

None


 

Back to top

DropOnItem Method

Description

Completes the drag and drop operation by dropping the node onto a specified target node.

Syntax

object.DropOnItem TargetItem, [BUTTON]

Arguments

Parameter Description
TargetItem Required. A Variant.

The full path of the node on which to drop the dragged node. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

BUTTON Optional. An integer value.

A pre-defined constant or number. See the Constants table, below. The mouse button used to drop the node.  

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


Default value = 0

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 a node in the tree view to enable renaming.

Syntax

object.EditLabel Item

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node containing the label you want to edit. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0. 

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

Return Type

None

IMPORTANT

This method only enables the node for renaming. To actually rename the node, 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

Expand Method

Description

Displays hidden sub-nodes of the specified node in the tree view.

Syntax

object.Expand Item

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node to expand in the tree-view control. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

Return Type

None

Example


 

Back to top

ExtendSelect Method

Description

Selects an additional item.

Syntax

object.ExtendSelect Item, [BUTTON]

Arguments

Parameter Description
Item Required. A Variant.
The full path of the node whose check box you want to select. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.
BUTTON Optional. A predefined constant or number.
The mouse button to use for selecting the additional node.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

GetCheckMarks Method

Description

Retrieves the value of items marked as checked.

Syntax

object.GetCheckMarks

Return Type

A String value.

IMPORTANT

You can use this method only for tree-view controls with 1000 or fewer nodes.

Example


 

Back to top

GetContent Method

Description

Returns all of the nodes in the tree view.

Syntax

object.GetContent

Return Type

A String value.

The returned string contains all of the nodes in the tree-view control separated by VBScript line feed characters.

Example


 

Back to top

GetItem Method

Description

Returns the value of the node specified by the index.

Syntax

object.GetItem (Item)

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node you want to retrieve. The path is composed of the numeric index of the nodes (without quotes) separated by a semicolon. The first node in a tree-view control is numbered 0.

Note: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

Return Type

A String value.

Example


 

Back to top

GetItemIndex Method

Description

Returns the index of a tree control.

Syntax

object.GetItemIndex (Item)

Arguments

Parameter Description
Item Required. A Variant.
The full path of the node whose index you want to retrieve. The path is composed of the names of the nodes (with quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Return Type

A long integer value.

Example


 

Back to top

GetItemProperty Method

Description

Returns the current value of a property for a node in the tree view.

Syntax

object.GetItemProperty (Item, Property)

Arguments

Parameter Description
Item Required. A Variant.
The full path of the node whose property you want to retrieve. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree is numbered 0.

Property Required. A Variant.

The node property for which you want to retrieve a value. The following properties are supported:

Property Name
Description
selected
Indicates whether the node is selected.
Possible values:                                    
       True
       False
state
The state image index of the node.

Return Type

A String value.

Example


 

Back to top

GetItemsCount Method

Description

Returns the number of nodes in the tree view.

Syntax

object.GetItemsCount

Return Type

A long integer value.

Example


 

Back to top

GetSelection Method

Description

Returns all of the selected nodes in the tree view.

Syntax

object.GetSelection

Return Type

A String value.

The returned string contains all of the selected nodes in the tree-view control separated by VBScript line feed characters.

Example


 

Back to top

GetSubItem Method

Description

Returns the Column value of a tree control.

Syntax

object.GetSubItem (Item, SubItemIndex)

Arguments

Parameter Description
Item Required. A Variant.
The full path of the sub-item to retrieve. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.
SubItemIndex Required. An integer value.
The numeric index of the sub-item you want to retrieve. If no value is specified, the first sub-item (index = 0) is used.

Return Type

A String value.


 

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.

IMPORTANT


 

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


 

Back to top

MouseMove Method

Description

Moves the mouse pointer to the designated position inside the 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


 

Back to top

Select Method

Description

Selects a node in the tree view.

Syntax

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

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node whose check box you want to select. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

BUTTON Optional. A predefined constant or number.
A pre-defined constant or number. See the Constants table, below. The mouse button used to click the node.
Default value = micLeftBtn
Offset Optional. An integer value.
The horizontal offset (in pixels) of the click location relative to the left margin of the node'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

SetItemState Method

Description

Sets the state of the check box icon of the specified node in the tree view.

Syntax

object.SetItemState Item, State

Arguments

Parameter Description
Item Required. A Variant.

The full path of the node whose check box you want to set. The path is composed of the names of the nodes (with quotes) or numeric index (without quotes) separated by a semicolon. When specifying the index, the first node in a tree-view control is numbered 0.

Note 1: If the node is identified by its full path, the default path delimiter is ';'. For example, "Root;Child1;Child2". If the default path delimiter character is used in a node name, you can change the delimiter character for your test or component using the "TreePathDelimiter" setting value. For example, Setting.Item("TreePathDelimiter") = "#"
Note 2: If the node is identified by its numeric index, UFT counts only the expanded nodes. Child nodes of a collapsed parent node are not counted. The first root node in a tree-view control is numbered 0.

State Required. An integer value.
The state you want to set. The state can either be an index, or one of the following state constants:

micChecked (1)--Selects the node check box.
micUnchecked (0)--Clears the node check box.
micClick (-1)--Clicks the node icon.
micDblClick (-2)--Double-clicks the node 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.


Back to top

See also: