WpfObject Object
Description
An object 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 OpenText Functional Testing supports for a specific WpfObject 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 OpenText Functional Testing Help Center.
Operations
The sections below list the built-in methods and properties that you can use as operations for the WpfObject object.
Note: You can also view a list and descriptions of the WpfObject 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. |
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. |
GetROProperty | Returns the current value of the description property from the object in the application. |
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 OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ShowContextMenu | Displays the control'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
AutomationElement | Accesses the native methods and properties of the AutomationElement object for the corresponding user interface object. |
AutomationPattern | The object that provides access to the specified Control Pattern for the run-time object. |
Exist | Checks whether the object currently exists in the open application. |
Object | Accesses the native methods and properties of the object. |
SupportedPatterns | Returns all of the currently supported patterns 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.
Example
'The following example uses the Click method to click the left mouse button 'on the 'OK' button. WpfWindow("SimpleStyles").WpfButton("OK").Click
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.
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
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.
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
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.
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
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.
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 OpenText Functional Testing 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 OpenText Functional Testing 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
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
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.
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
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"
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.
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"
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 OpenText Functional Testing 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 OpenText Functional Testing 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
AutomationPattern Property
Description
The object that provides access to the specified Control Pattern for the run-time object.
Syntax
object.AutomationPattern (NameOrIndex)
Arguments
Parameter | Description |
---|---|
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 OpenText Functional Testing 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 OpenText Functional Testing 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
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
See also: