WpfTreeView Object

Description

A tree control in a Windows Presentation Foundation application.

IMPORTANT

Because WPF Automation Elements of the same control type may support a different set of control patterns, the test object methods or properties that UFT One supports for a specific WpfTreeView test object may be different from the standard set of methods and properties listed in this section.  For more information on control patterns, see the WPF Add-in section of the UFT One Help Center.

Operations

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

Note: You can also view a list and descriptions of the WpfTreeView 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 CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method ClickClicks the object.
Method CollapseCollapses the specified tree node to hide its child nodes.
Method DblClickDouble-clicks the object.
Method DragPerforms the 'drag' part of a drag-and-drop operation.
Method DragItemPerforms the 'drag' part of a drag and drop operation.
Method DropPerforms the 'drop' part of a drag-and-drop operation.
Method DropOnItemPerforms the 'drop' part of a drag and drop operation.
Method ExpandExpands the specified tree node to display its child nodes.
Method ExpandAllExpands the specified tree node and its child nodes to display all of its child nodes.
Method GetContentReturns all of the expanded nodes in the Tree.
Method GetItemReturns the value of the node specified by the index.
Method GetItemPropertyReturns the current value of a property for a node in the tree.
Method GetItemsCountReturns the number of nodes in the tree.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Method GetSelectionReturns all of the selected nodes in the Tree.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method GetVisibleTextReturns the text from the specified area.
Method MakeVisibleScrolls the object into view if it is not visible in the parent window.
Method MouseMoveMoves the mouse pointer to the designated position over the object.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectSelects a node in the tree.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method ShowContextMenuDisplays the control's context menu.
Common Method ToStringReturns a string that represents the test object.
Method TypeTypes the specified string in the object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property AutomationElementAccesses the native methods and properties of the AutomationElement object for the corresponding user interface object.
Property AutomationPatternThe object that provides access to the specified Control Pattern for the run-time object.
Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.
Property SupportedPatternsReturns all of the currently supported patterns of the object.

Back to top

 

Click Method

Description

Clicks the object.

Syntax

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

Arguments

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

Example

                    'The following example uses the Click method to click the left mouse button
'on the 'OK' button.
WpfWindow("SimpleStyles").WpfButton("OK").Click

Back to top

 

Collapse Method

Description

Collapses the specified tree node to hide its child nodes.

Syntax

object.Collapse Node

Arguments

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

None

Example

                    'The following example collapses the 'Top One' item of the TreeView.
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").Collapse ("Top One")

Back to top

 

DblClick Method

Description

Double-clicks the object.

Syntax

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

Arguments

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

Example

                    'The following example uses the DblClick method to Double-Click a WpfButton object at
'coordinates 2, 2.
WpfWindow("SimpleStyles").WpfButton("Default").DblClick 2, 2

Back to top

 

Drag Method

Description

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

Syntax

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

Arguments

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

Example

                    'The following example uses the Drag and Drop methods to move a WpfSlider handle.
WpfWindow("SimpleStyles").WpfSlider("WpfSlider").Drag 4, 8
WpfWindow("SimpleStyles").WpfSlider("WpfSlider").Drop 24, 8

Back to top

 

DragItem Method

Description

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

Syntax

object.DragItem Item

Arguments

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

None

Example

                    'The following example uses the Drag Item method to drag the "Child1" item from the "Tree0Node1" node in the "treeView0" tree view.
'It then uses the DropOnItem method to drop the "Child1" item onto the "Tree1Node3" node in the "treeView1" tree view.
WpfWindow("AUT").WpfTreeView("treeView0").DragItem "Tree0Node1;Child1"
WpfWindow("AUT").WpfTreeView("treeView1").DropOnItem "Tree1Node3"

Back to top

 

Drop Method

Description

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

Syntax

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

Arguments

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

Example

                    'The following example uses the Drag and Drop methods to move a WpfSlider handle.
WpfWindow("SimpleStyles").WpfSlider("WpfSlider").Drag 4, 8
WpfWindow("SimpleStyles").WpfSlider("WpfSlider").Drop 24, 8

Back to top

 

DropOnItem Method

Description

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

Syntax

object.DropOnItem TargetItem

Arguments

ParameterDescription
TargetItem Required. A Variant.

The full path of the node on which to drop the dragged item 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 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

None

Example

                    'The following example uses the Drag Item method to drag the "Child1" 
'item from the "Tree0Node1" node in the "treeView0" tree view.
   'It then uses the DropOnItem method to drop the "Child1" item onto the 
'"Tree1Node3" node in the "treeView1" tree view.
   WpfWindow("AUT").WpfTreeView("treeView0").DragItem "Tree0Node1;Child1"
   WpfWindow("AUT").WpfTreeView("treeView1").DropOnItem "Tree1Node3"

Back to top

 

Expand Method

Description

Expands the specified tree node to display its child nodes.

Syntax

object.Expand Node

Arguments

ParameterDescription
Node 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 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

None

Example

                    'The following example checks if the 'Top One' item of the TreeView is selected
'and if it is, expands it.
IsTopOneSelected = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItemProperty("Top One", "selected")
If IsTopOneSelected Then
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").Expand ("Top One")
End If

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

ParameterDescription
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

Example

                    'The following example uses the ExpandAll method to expand all child items below
'the 'Top Two' node.
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").ExpandAll "Top Two"

Back to top

 

GetContent Method

Description

Returns all of the expanded nodes in the Tree.

Syntax

object.GetContent

Return Type

A String value.

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

Example

                    'The following example uses the GetContent method to return all the nodes in the
''WpfTreeView' tree view.
      WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetContent

Back to top

 

GetItem Method

Description

Returns the value of the node specified by the index.

Syntax

object.GetItem (Index)

Arguments

ParameterDescription
Index Required. A Variant.
The full path of the expanded 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.

Example

                    'The following example selects the last root item of a tree.
cnt = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItemsCount
LastRoot = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItem(cnt - 1)
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").Select LastRoot

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

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

Example

                    'The following example checks if the 'Top One' item of the TreeView is selected
'and if it is, expands it.
IsTopOneSelected = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItemProperty("Top One", "selected")
If IsTopOneSelected Then
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").Expand ("Top One")
End If

Back to top

 

GetItemsCount Method

Description

Returns the number of nodes in the tree.

Syntax

object.GetItemsCount

Return Type

A long integer value.

Example

                    'The following example selects the last root item of a tree.
cnt = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItemsCount
LastRoot = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItem(cnt - 1)
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").Select LastRoot

Back to top

 

GetSelection Method

Description

Returns all of the selected nodes in the Tree.

Syntax

object.GetSelection

Return Type

A String value.

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

Example

                    'The following example uses the GetSelection method to return the selected item in the
''WpfTreeView' tree view.
        sel = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetSelection

Back to top

 

GetVisibleText Method

Description

Returns the text from the specified area.

Syntax

object.GetVisibleText ([Left], [Top], [Right], [Bottom])

Arguments

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

Note:

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

Example

                    'The following example uses the GetVisibleText method to retrieve the text displayed
'inside a WpfButton object.
WpfWindow("SimpleStyles").WpfButton("Default").GetVisibleText

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.

Example

                    'The following example uses the MakeVisible method to scroll the 'WpfTabStrip' WpfTabStrip
'object into the view area.
WpfWindow("SimpleStyles").WpfTabStrip("WpfTabStrip").MakeVisibl

Back to top

 

MouseMove Method

Description

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

Syntax

object.MouseMove (X, Y)

Arguments

ParameterDescription
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 'WpfTabStrip' object.
WpfWindow("SimpleStyles").WpfTabStrip("WpfTabStrip").MouseMove 0, 0

Back to top

 

Select Method

Description

Selects a node in the tree.

Syntax

object.Select Node

Arguments

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

None

Example

                    'The following example selects the last root item of a tree.
cnt = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItemsCount
LastRoot = WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").GetItem(cnt - 1)
WpfWindow("SimpleStyles").WpfTreeView("WpfTreeView").Select LastRoot

Back to top

 

ShowContextMenu Method

Description

Displays the control's context menu.

Syntax

object.ShowContextMenu

Return Type

None.

Example

                    'The following example opens the context menu of a button object and selects the 'ToolBar' item.
WpfWindow("Controls").WpfButton("Right click here for a").ShowContextMenu
WpfWindow("Controls").WpfMenu("WpfMenu").Select "ToolBar"

Back to top

 

Type Method

Description

Types the specified string in the object.

Syntax

object.Type (KeyboardInput)

Arguments

ParameterDescription
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

                    'The following example confirms that the edit box supports text selection and then
'copies the first 6 characters from the edit box to the clipboard.
   CanSelect = WpfWindow("SimpleStyles").WpfEdit("Name").SupportsTextSelection
   If CanSelect <> False Then
        WpfWindow("SimpleStyles").WpfEdit("Name").SetSingleLineSelection 0, 5
        WpfWindow("SimpleStyles").WpfEdit("Name").Type micCtrlDwn
        WpfWindow("SimpleStyles").WpfEdit("Name").Type "c"
        WpfWindow("SimpleStyles").WpfEdit("Name").Type micCtrlUp
   End If
                    'The following example uses the Type method to type '123' in the WpfEdit object.
 WpfWindow("SimpleStyles").WpfEdit("WpfEdit").Type "123"

Back to top

 

AutomationElement Property

Description

Accesses the native methods and properties of the AutomationElement object for the corresponding user interface object.

Syntax

object.AutomationElement

Value Type

An Object.

Property type

Read-only property

IMPORTANT

The AutomationElement property returns an object that represents a Windows Presentation Foundation UI Automation element. The returned object provides access to the common methods and properties specific to the element's control type. For more information, see the WPF Add-in section of the UFT One Help Center.

You can use the AutomationPattern Property to access the properties and methods provided by UI Automation for a specific instance of a Control Pattern of the element's control type.

You can use the Object Property to access the properties and methods of Windows Presentation Foundation user interface objects.

For more information, see the WPF Add-in section of the UFT One Help Center.

Example

                    'The following example uses the AutomationElement property to obtain the ClassName
'of the UI control related to the WpfCheckBox('Normal') Test Object.
WpfWindow("SimpleStyles").WpfCheckBox("Normal").AutomationElement.Current.ClassName

Back to top

 

AutomationPattern Property

Description

The object that provides access to the specified Control Pattern for the run-time object.

Syntax

object.AutomationPattern (NameOrIndex)

Arguments

ParameterDescription
NameOrIndex Required. A Variant.
The name or index of the Automation Pattern to access. When specifying the index, the first item in the list of supported patterns is numbered 0.

Value Type

An Object.

Property type

Read-only property

IMPORTANT

The AutomationPattern property returns an object that provides access to a specific instance of a Control Pattern. For more information, see the WPF Add-in section of the UFT One Help Center.

Tip: Use the SupportedPatterns property to access a list of the currently supported patterns for the object.

You can use the AutomationElement Property to access the common methods and properties provided by UI Automation that are specific to the element's control type.

You can use the Object Property to access the properties and methods of Windows Presentation Foundation user interface objects.

For more information, see the WPF Add-in section of the UFT One Help Center.

Example

'The following example uses the AutomationPattern property to toggle a state of the
''Normal' check box.
WpfWindow("SimpleStyles").WpfCheckBox("Normal").AutomationPattern("Toggle").Toggle

Back to top

 

SupportedPatterns Property

Description

Returns all of the currently supported patterns of the object.

Syntax

object.SupportedPatterns

Value Type

A String value.

Property type

Read-only property

IMPORTANT

A control may not always support the same set of control patterns. For example, a multiline edit box supports vertical scrolling only if the number of lines it contains exceeds its viewable area. Scrolling is disabled when enough text is removed so that scrolling is not required.

Example

'The following example uses the SupportedPatterns property to check if the
''SimpleStyles' window supports the Transform pattern. If it does, the window will
'be resized. If it does not, then an error message will be sent to the report.

patterns = WpfWindow("SimpleStyles").SupportedPatterns
If InStr(1, patterns, "Transform") Then
    WpfWindow("SimpleStyles").Resize 200, 200
    Else
   Reporter.ReportEvent micWarning, "SimpleStyles", "The Transform pattern is not supported."
End If

Back to top

See also: