SlvTreeView Object
Note: Following the discontinuance of the Silverlight development framework, UFT One no longer supports the Silverlight Add-in out of the box.
If you require the Silverlight Add-in, contact OpenText Support.
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
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 the object. |
Collapse | Collapses the specified tree node to hide its child nodes. |
DblClick | Double-clicks the object. |
Drag | Performs the 'drag' part of a drag-and-drop operation. |
Drop | Performs the 'drop' part of a drag-and-drop operation. |
Expand | Expands the specified tree node to display its child nodes. |
ExpandAll | Expands the specified tree node and its child nodes to display all of its child nodes. |
GetContent | Returns all of the nodes in the tree. |
GetItem | Returns the value of the node specified by the index. |
GetItemChildObjects | Returns the collection of child objects contained within the specified item. |
GetItemProperty | Returns the current value of a property for a node in the tree. |
GetItemsCount | Returns the number of nodes in the tree. |
GetROProperty | Returns the current value of the description property from the object in the application. |
GetSelection | Returns all of the selected nodes in the tree. |
GetTOProperties | Returns the collection of properties and values used to identify the object. |
GetTOProperty | Returns the value of the specified description property from the test object description. |
Highlight | Highlights the object in the application. |
GetVisibleText | Returns the text from the specified area. |
MakeVisible | Scrolls the object into view if it is not visible in the parent window. |
MouseMove | Moves the mouse pointer to the designated position over the object. |
Output | Retrieves the current value of an item and stores it in a specified location. |
RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
Select | Selects a node in the tree. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ShowContextMenu | Displays the object's context menu. |
ToString | Returns a string that represents the test object. |
Type | Types the specified string in the object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
DescriptionValue | Retrieves the text displayed in the tooltip of the object's associated DescriptionViewer. |
Exist | Checks whether the object currently exists in the open application. |
IsValid | Indicates whether the data in the current object is valid. |
Object | Accesses the native methods and properties of the object. |
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.
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") = "#" |
Return Type
None
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.
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.
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.
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") = "#" |
Return Type
None
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
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.
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 One 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.
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 UFT One Object Model Reference. |
Return Type
An Object.
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") = "#" | ||||||||||||||||||||
Property |
Required. A String value. The node property for which you want to retrieve a value. The following properties are supported:
|
Return Type
A Variant.
GetItemsCount Method
Description
Returns the number of nodes in the tree.
Syntax
object.GetItemsCount
Return Type
A long integer value.
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.
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 GetVisibleText method may behave differently 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 or the Object property to retrieve the value of the text (or equivalent) property from an object in your application instead of using the GetVisibleText method.
- By default, when UFT One captures text for a text/text area checkpoint or output value step using the GetText, GetTextLocation, or GetVisibleText methods, it tries to retrieve the text directly from the object using a Windows API-based mechanism. If UFT One cannot capture the text this way (for example, because the text is part of a picture), it tries to capture the text using an OCR (optical character recognition) mechanism. For details about changing this behavior, see the Can QuickTest Professional Text Recognition behavior be modified Knowledgebase article (number KM202721).
MakeVisible Method
Description
Scrolls the object into view if it is not visible in the parent window.
Syntax
object.MakeVisible
Return Type
None.
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.
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") = "#" |
Return Type
None
ShowContextMenu Method
Description
Displays the object's context menu.
Syntax
object.ShowContextMenu
Return Type
None.
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:
|
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.
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
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 One retrieves the value of the IsValid property of the DescriptionViewer control associated with the Silverlight control represented by this test object.
See also: