Object Model Reference for GUI Testing > .NET Silverlight > Click Method

SlvTreeView Object

Description

A tree view control in a Silverlight application.

Operations

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

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

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 the object.
Method Collapse Collapses the specified tree node to hide its child nodes.
Method DblClick Double-clicks the object.
Method Drag Performs the 'drag' part of a drag-and-drop operation.
Method Drop Performs the 'drop' part of a drag-and-drop operation.
Method Expand Expands the specified tree node to display its child nodes.
Method ExpandAll Expands the specified tree node and its child nodes to display all of its child nodes.
Method GetContent Returns all of the nodes in the tree.
Method GetItem Returns the value of the node specified by the index.
Method GetItemChildObjects Returns the collection of child objects contained within the specified item.
Method GetItemProperty Returns the current value of a property for a node in the tree.
Method GetItemsCount Returns the number of nodes in the tree.
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.
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 MakeVisible Scrolls the object into view if it is not visible in the parent window.
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 a node in the tree.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method ShowContextMenu Displays the object's context menu.
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

Property DescriptionValue Retrieves the text displayed in the tooltip of the object's associated DescriptionViewer.
Common Property Exist Checks whether the object currently exists in the open application.
Property IsValid Indicates whether the data in the current object is valid.
Common Property Object Accesses the native methods and properties of the object.

Back to top

 

Click Method

Description

Clicks the object.

Syntax

object.Click ([X], [Y], [BUTTON])

Arguments

Parameter Description
X Optional. An integer value.
The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -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

Collapses the specified tree node to hide its child nodes.

Syntax

object.Collapse Node

Arguments

Parameter Description
Node 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

Back to top

 

DblClick Method

Description

Double-clicks the 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. The default value is the center of the object.
Y Required. 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.

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

 

Drag Method

Description

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

Syntax

object.Drag ([X], [Y], [BUTTON])

Arguments

Parameter Description
X Optional. 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.
Default value = -9999
Y Optional. 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.
Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object.
Default value = micLeftBtn

Return Type

None.

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 Optional. 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.
Default value = -9999
Y Optional. 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.
Default value = -9999
BUTTON Optional. A predefined constant or number.
The mouse button that is released to drop the object.
Default value = micLeftBtn

Return Type

None.

Back to top

 

Expand Method

Description

Expands the specified tree node to display its child nodes.

Syntax

object.Expand Node

Arguments

Parameter Description
Node Required. A Variant.
Required. A Variant value. 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

Back to top

 

ExpandAll Method

Description

Expands the specified tree node and its child nodes to display all of its child nodes.

Syntax

object.ExpandAll Node

Arguments

Parameter Description
Node Required. A Variant.
The full path of the node to expand. 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

Back to top

 

GetContent Method

Description

Returns all of the nodes in the tree.

Syntax

object.GetContent

Return Type

A String value.

Return Value Details

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

Back to top

 

GetItem Method

Description

Returns the value of the node specified by the index.

Syntax

object.GetItem (Index)

Arguments

Parameter Description
Index Required. A Variant.
The full path of the node you want to retrieve in the tree-view control. 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.

Back to top

 

GetItemChildObjects Method

Description

Returns the collection of child objects contained within the specified item.

Syntax

object.GetItemChildObjects (Item, [Description])

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.
Description Optional. An Object.
A Properties (collection) object containing the description of the objects contained within the specified item. 

Tip: You can can retrieve a Properties collection using the GetTOProperties method or you can build a Properties collection object using the Description object.  For more information on the Description object, see the Utility Objects section of the Unified Functional Testing Object Model Reference.

Return Type

An Object.

Back to top

 

GetItemProperty Method

Description

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

Syntax

object.GetItemProperty (Node, Property)

Arguments

Parameter Description
Node 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 String value.
The node property for which you want to retrieve a value. The following properties are supported:
Property Name
Description
expanded 
Indicates whether the node is currently expanded.
Possible values:
True--node is currently expanded
False--node is currently collapsed
firstchild 
The full path of the node's first child node as a semi-colon delimited string.
haschildren 
Indicates whether the node has children.
Possible values:
True--node has children
False--node does not have children 
nextsibling
The full path of the node's next sibling node as a semi-colon delimited string.
parent
The full path of the node's parent node as a semi-colon delimited string.
path 
The full path of the node as a semi-colon delimited string.
selected
Indicates whether the node is selected.
Possible values:
True
False
state
The current state of the check box (available only for nodes with check boxes).
Possible values:
Checked
NotChecked
NotApplicable
text
The text of the node, or "" if the node does not contain any text.

 

Return Type

A Variant.

Back to top

 

GetItemsCount Method

Description

Returns the number of nodes in the tree.

Syntax

object.GetItemsCount

Return Type

A long integer value.

Back to top

 

GetSelection Method

Description

Returns all of the selected nodes in the tree.

Syntax

object.GetSelection

Return Type

A String value.

Return Value Details

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

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

 

MakeVisible Method

Description

Scrolls the object into view if it is not visible in the parent window.

Syntax

object.MakeVisible

Return Type

None.

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 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.

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.

Back to top

 

Select Method

Description

Selects a node in the tree.

Syntax

object.Select Node

Arguments

Parameter Description
Node Required. A Variant.
The full path of the node to select 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

Back to top

 

ShowContextMenu Method

Description

Displays the object's context menu.

Syntax

object.ShowContextMenu

Return Type

None.

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

 

DescriptionValue Property

Description

Retrieves the text displayed in the tooltip of the object's associated DescriptionViewer.

Syntax

object.DescriptionValue

Value Type

A String value.

Property type

Read-only property

Back to top

 

IsValid Property

Description

Indicates whether the data in the current object is valid.

Syntax

object.IsValid

Value Type

A Boolean value.

Property type

Read-only property

IMPORTANT

UFT retrieves the value of the IsValid property of the DescriptionViewer control associated with the Silverlight control represented by this test object.

Back to top

See also: