WpfToolbar Object

Description

A toolbar 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 WpfToolbar 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 WpfToolbar object.

Note: You can also view a list and descriptions of the WpfToolbar 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.
Method CheckItemPropertyChecks whether the specified item property has 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 DblClickDouble-clicks the object.
Method DragPerforms the 'drag' part of a drag-and-drop operation.
Method DropPerforms the 'drop' part of a drag-and-drop operation.
Method GetContentReturns the names of all of the items in the toolbar.
Method GetItemReturns the name of the toolbar item specified by the index.
Method GetItemPropertyReturns the current value of a property for a toolbar item.
Method GetItemsCountReturns the number of items in the toolbar.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
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.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method ShowContextMenuDisplays the control's context menu.
Method ShowOverflowDisplays the overflow area of the toolbar.
Common Method ToStringReturns a string that represents the test object.
Method TypeTypes the specified string in the object.
Method WaitItemPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.
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.
Property IsOverflowIndicates whether the item resides in the overflow area of the toolbar.
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

 

CheckItemProperty Method

Description

Checks whether the specified item property has the expected value.

Syntax

object.CheckItemProperty (Item, PropertyName, ExpectedValue)

Arguments

ParameterDescription
Item Required. A Variant.
The item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a toolbar is numbered 1.
PropertyName Required. A String value.
Property to retrieve from the toolbar button. The following properties are supported:
Property Name
Description
checked
Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
Possible values:                                    
       True
       False
ellipses
Indicates whether the toolbar item’s text is truncated and an ellipsis (...) is displayed.
Possible values:                                    
       True
       False
enabled
Indicates whether the toolbar item is enabled (accepts user input).
Possible values:                                    
       True
       False
hot
Indicates whether the toolbar item is "hot". (A hot toolbar item appears highlighted when the mouse pointer is over it.)
Possible values:                                    
       True
       False
index
The index number of the toolbar item. The index does not include hidden and separator buttons.
Values begin with 1.
name
The name of the toolbar item.
type
The control type of the toolbar item.
ExpectedValue Required. A Variant.
The expected value against which the actual item property value should be checked. You can either use a simple value or you can use a comparison object together with the value to perform more complex comparisons.

Return Type

An integer value.

Returns TRUE if the item property achieves the value, and FALSE if the timeout is reached before the item property achieves the value.

A TRUE return value reports a Passed step to the run results; a FALSE return value reports a Failed step to the run results.

IMPORTANT

If the expected and actual values do not match, an error is reported and the test or component status is changed to failed.

Note: For test run synchronization, or whenever you do not want to fail the test if the expected and actual values do not match, use the WpfPackageLib~WinToolbar~WaitItemProperty method.

You can also use comparison objects to perform more complex value comparisons. For example, you can instruct UFT One to check whether a specific item property value is greater than the specified value.

An example of the syntax required when using a comparison object is: Object.CheckItemProperty 2, "text", micNotEqual("John")"

The following comparison objects can be used:

  • micGreaterThan: Greater than; Specifies that UFT One checks whether the item property value is greater than the specified value.
  • micLessThan: Less than; Specifies that UFT One checks whether the item property value is less than the specified value.
  • micGreaterThanOrEqual: Greater than or equal to; Specifies that UFT One checks whether the item property value is greater than or equal to the specified value.
  • micLessThanOrEqual: Less than or equal to; Specifies that UFT One checks whether the item property value is less than or equal to the specified value.
  • micNotEqual: Not equal to; Specifies that UFT One checks whether the item property value is not equal to the specified value.
  • micRegExpMatch: Regular expression; Specifies that UFT One checks whether the item property value achieves a regular expression match with the specified value. Regular expressions are case-sensitive and must match exactly. For example, 'E.*h' matches 'Earth' but not 'The Earth' or 'earth'.

When the types of the expected value and actual value do not match, the comparisons are performed as follows (in this order):

  • Empty values: Empty values may be an uninitialized variable or field (which returns TRUE for the IsNull function in VBscript) or initialized to an empty value (which returns TRUE for the IsEmpty function is VBscript). When trying to compare two arguments when at least one is an empty value, the comparison assumes equality for two uninitialized arguments and for two empty arguments. Any other combination is considered unequal.
    For example:
    dim vEmpty
    Object.CheckItemProperty 2, “text”,micNotEqual    (vEmpty) 
    will not wait for the timeout (because the 'text' property value is an empty string and the argument passed to micNotEqual is an empty value, and so micNotEqual finds them not equal and returns TRUE).
  • String values: When trying to compare a string value with non-string value, the string value is converted to the non-string type and then compared. If the string value cannot be converted to the non-string type, the comparison assumes the values are not equal.
    For example:
    Object.CheckItemProperty 2, "text", micGreaterThan("8")"
    will not wait for the timeout if the 'text' property value is '16' (because micGreaterThan finds 16 to be greater than 8 and returns TRUE), but will wait if the 'text' property value is 'a' (because 'a' cannot be converted to a number).
  • Boolean values: When trying to compare a Boolean value with non-boolean value, the non-boolean value is converted to a boolean value and then compared. The conversion method assumes that any integer value other than '0' is TRUE, and that '0' alone is FALSE. If the conversion fails to produce a boolean value (for example, if the value is 'abc'), the comparison result will be FALSE (note that for the WaitProperty method this result would instruct UFT One to keep waiting). If the conversion succeeds, the method compares the two boolean values according to the comparison logic.
  • Other value types: When other value types do not match, they are compared under the assumption that different types are not equal (nor greater than or less than each other).

 

Example

                    'The following example uses the CheckItemProperty method to check that the 'Format'
'button is enabled.
WpfWindow("Controls").WpfToolBar("WpfToolbar").CheckItemProperty "Format", "enabled", 0

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

 

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

 

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

 

GetContent Method

Description

Returns the names of all of the items in the toolbar.

Syntax

object.GetContent

Return Type

A String value.

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

Example

                    'The following example uses the GetContent method to return the names of all the
'controls in the 'WpfToolbar' toolbar and to write them to the run results.
Reporter.ReportEvent micDone, "Toolbar content", WpfWindow("Controls").WpfToolBar("WpfToolbar").GetContent()

Back to top

 

GetItem Method

Description

Returns the name of the toolbar item specified by the index.

Syntax

object.GetItem (Index)

Arguments

ParameterDescription
Index Required. An integer value.
Numeric index of the button. Index values begin with 1.

Return Type

An integer value.

Example

                    'The following example uses the GetItem method to retrieve the name of the first
'toolbar element.
        sName = WpfWindow("Controls").WpfToolBar("WpfToolbar").GetItem(1)
        sReport = "Name=" & sName
        Reporter.ReportEvent micDone, "Toolbar data", sReport

Back to top

 

GetItemProperty Method

Description

Returns the current value of a property for a toolbar item.

Syntax

object.GetItemProperty (NameOrIndex, PropertyName)

Arguments

ParameterDescription
NameOrIndex Required. A Variant.
Name of the toolbar item in the toolbar or its numeric index. Index values begin with 1.
PropertyName Required. A String value.
Property to retrieve from the toolbar item. The following properties are supported: 
Property Name
Description
checked
Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
Possible values:                                    
       True
       False
Note: For tri-state checkboxes in toolbars, a checkbox with a dimmed state returns True.
ellipses
Indicates whether the toolbar item’s text is truncated and an ellipsis (...) is displayed.
Possible values:                                    
       True
       False
enabled
Indicates whether the toolbar item is enabled (accepts user input).
Possible values:                                    
       True
       False
hot
Indicates whether the toolbar item is "hot". (A hot toolbar item appears highlighted when the mouse pointer is over it.)
Possible values:                                    
       True
       False
index
The index number of the toolbar item. The index does not include hidden and separator buttons.
Values begin with 1.
name
The name of the toolbar item.
type
The control type of the toolbar item.

Return Type

A String value.

For example, the "name" property returns a string containing the name of the item.?

Example

                    'The following example uses the GetItemProperty method to retrieve the enabled,
'and index properties of each element in the 'WpfToolbar' toolbar, and then write this information to the run results.

    cItems = WpfWindow("Controls").WpfToolBar("WpfToolbar").GetItemsCount
    sReport = "Toolbar elements count " & cItems & vbCr
    For iItem = 1 To cItems
        sName = WpfWindow("Controls").WpfToolBar("WpfToolbar").GetItem(iItem)
        sReport = sReport & "Name " & sName & vbTab
        sReport = sReport & "enabled " & WpfWindow("Controls").WpfToolBar("WpfToolbar").GetItemProperty(iItem, "enabled") & vbTab
        sReport = sReport & "index " & WpfWindow("Controls").WpfToolBar("WpfToolbar").GetItemProperty(iItem, "index") & vbCr
    Next
Reporter.ReportEvent micDone, "Toolbar data", sReport

Back to top

 

GetItemsCount Method

Description

Returns the number of items in the toolbar.

Syntax

object.GetItemsCount

Return Type

An integer value.

Example

                    'The following example uses the GetItemsCount method to return the number of elements
'in the 'WpfToolbar' toolbar and to write it to the run results.
cItems = WpfWindow("Controls").WpfToolBar("WpfToolbar").GetItemsCount
sReport = "Toolbar elements count " & cItems & vbCr
Reporter.ReportEvent micDone, "Toolbar data", sReport

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

 

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

 

ShowOverflow Method

Description

Displays the overflow area of the toolbar.

Syntax

object.ShowOverflow

Return Type

None

Example

                    'The following example checks whether the 'Help' button resides in the toolbar
'overflow area and if it does exposes the overflow area. It then selects the 'Help'
'button.
        isHidden = WpfWindow("Controls").WpfToolBar("WpfToolbar").IsOverflow("Help")
        If isHidden Then
            WpfWindow("Controls").WpfToolBar("WpfToolbar").ShowOverflow
        End If
        WpfWindow("Controls").WpfButton("Help").Click

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

 

WaitItemProperty Method

Description

Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Syntax

object.WaitItemProperty (Item, PropertyName, ExpectedValue, TimeOut)

Arguments

ParameterDescription
Item Required. A Variant.
The item name (with quotes) or numeric index (without quotes) can denote the item. The first item in a toolbar is numbered 1.
PropertyName Required. A String value.
The name of the item property whose value to wait for. The following properties are supported:
Property Name
Description
checked
Indicates whether the toolbar button is a dual-state (toggle) push button and is currently selected (pushed).
Possible values:                                    
       True
       False
ellipses
Indicates whether the toolbar item’s text is truncated and an ellipsis (...) is displayed.
Possible values:                                    
       True
       False
enabled
Indicates whether the toolbar item is enabled (accepts user input).
Possible values:                                    
       True
       False
hot
Indicates whether the toolbar item is "hot". (A hot toolbar item appears highlighted when the mouse pointer is over it.)
Possible values:                                    
       True
       False
index
The index number of the toolbar item. The index does not include hidden and separator buttons.
Values begin with 1.
name
The name of the toolbar item.
type
The control type of the toolbar item.
ExpectedValue Required. A Variant.
The expected value against which the actual item property value should be checked. You can either use a simple value or you can use a comparison object together with the value to perform more complex comparisons.
TimeOut Required. An integer value.
The time, in milliseconds, after which UFT One continues to the next step if the specified item value is not achieved. If no value is specified, UFT One uses the time set in the Object Synchronization Timeout option in the Run pane of the Test Settings dialog box.

Return Type

An integer value.

Returns TRUE if the item property achieves the value, and FALSE if the timeout is reached before the item property achieves the value. A FALSE return value does not indicate a failed step.

IMPORTANT

Tip: This method is useful for test run synchronization. Unlike the Exist method and the WaitProperty method, the WaitItemProperty method enables you to synchronize the test run based on a specific object item property. For example, you can instruct UFT One to wait for a particular string to appear in the second panel of the "StatusBar" control:
'Wait up to 30 seconds for the string "Ready" to appear in the second panel of the "StatusBar" control.
Window("Test").WinStatusBar("StatusBar").WaitItemProperty 2, "text", "Ready", 30000

You can also use comparison objects to perform more complex value comparisons. For example, you can instruct UFT One to wait until a specific item property value is greater than the specified value.

An example of the syntax required when using a comparison object is: Object.WaitItemProperty 2, "text", micNotEqual("John")"

The following comparison objects can be used:

  • micGreaterThan: Greater than; Specifies that UFT One waits until the item property value is greater than the specified value.
  • micLessThan: Less than; Specifies that UFT One waits until the item property value is less than the specified value.
  • micGreaterThanOrEqual: Greater than or equal to; Specifies that UFT One waits until the item property value is greater than or equal to the specified value.
  • micLessThanOrEqual: Less than or equal to; Specifies that UFT One waits until the item property value is less than or equal to the specified value.
  • micNotEqual: Not equal to; Specifies that UFT One waits until the item property value is not equal to the specified value.
  • micRegExpMatch: Regular expression; Specifies that UFT One waits until the item property value achieves a regular expression match with the specified value. Regular expressions are case-sensitive and must match exactly. For example, 'E.*h' matches 'Earth' but not 'The Earth' or 'earth'.

When the types of the expected value and actual value do not match, the comparisons are performed as follows (in this order):

  • Empty values: Empty values may be an uninitialized variable or field (which returns TRUE for the IsNull function in VBscript) or initialized to an empty value (which returns TRUE for the IsEmpty function is VBscript). When trying to compare two arguments when at least one is an empty value, the comparison assumes equality for two uninitialized arguments and for two empty arguments. Any other combination is considered unequal.
    For example:
    dim vEmpty
    Object.WaitItemProperty 2, “text”,micNotEqual    (vEmpty) 
    will not wait for the timeout (because the 'text' property value is an empty string and the argument passed to micNotEqual is an empty value, and so micNotEqual finds them not equal and returns TRUE).
  • String values: When trying to compare a string value with non-string value, the string value is converted to the non-string type and then compared. If the string value cannot be converted to the non-string type, the comparison assumes the values are not equal.
    For example:
    Object.WaitItemProperty 2, “text”,micGreaterThan(8) will not wait for the timeout if the 'text' property value is '16' (because micGreaterThan finds 16 to be greater than 8 and returns TRUE), but will wait if the 'text' property value is 'a' (because 'a' cannot be converted to a number).
  • Boolean values: When trying to compare a Boolean value with non-boolean value, the non-boolean value is converted to a boolean value and then compared. The conversion method assumes that any integer value other than '0' is TRUE, and that '0' alone is FALSE. If the conversion fails to produce a boolean value (for example, if the value is 'abc'), the comparison result will be FALSE (note that for the WaitProperty method this result would instruct UFT One to keep waiting). If the conversion succeeds, the method compares the two boolean values according to the comparison logic.
  • Other value types: When other value types do not match, they are compared under the assumption that different types are not equal (nor greater than or less than each other).

Example

                    'The following example uses the WaitItemProperty method to wait three seconds for the 'Btn1' button to be enabled before clicking it.
'If it is not enabled within that time, it clicks the 'Btn2' button.

    rc = WpfWindow("Window1").WpfToolBar("toolBar1").WaitItemProperty(1, "enabled", True, 3000)
    Set ClickObj = WpfWindow("Window1").WpfButton("Btn2")
    If rc <> False Then
        Set ClickObj = WpfWindow("Window1").WpfButton("Btn1")
    End If
    ClickObj.Click

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

 

IsOverflow Property

Description

Indicates whether the item resides in the overflow area of the toolbar.

Syntax

object.IsOverflow (Item)

Arguments

ParameterDescription
Item Required. A Variant.
Name or numeric index of the toolbar item. Index values begin with 0.

Value Type

A Byte Value.

Property type

Read-only property

Example

'The following example checks whether the 'Help' button resides in the toolbar
'overflow area and if it does exposes the overflow area. It then selects the 'Help'
'button.
        isHidden = WpfWindow("Controls").WpfToolBar("WpfToolbar").IsOverflow("Help")
        If isHidden Then
            WpfWindow("Controls").WpfToolBar("WpfToolbar").ShowOverflow
        End If
        WpfWindow("Controls").WpfButton("Help").Click

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: