Share this page
WbfToolbar Object
Description
A .NET Web Forms toolbar control.
Operations
The sections below list the built-in methods and properties that you can use as operations for the WbfToolbar object.
Note: You can also view a list and descriptions of the WbfToolbar 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. |
| DoubleClick | Clicks on the object twice. |
| Drag | Performs the 'drag' part of a drag and drop operation. |
| Drop | Performs the 'drop' part of a drag and drop operation. |
| FireEvent | Triggers an event. |
| GetItem | Returns the name of the toolbar item specified by its index. |
| 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. |
| HoverTap | When hover is supported, places the pointer on the object. Otherwise, taps the object. |
| LongPress | Presses and holds the object. |
| MiddleClick | Middle-clicks the object. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| Pan | Perform a pan gesture. |
| Pinch | Perform a pinch gesture. |
| Press | Clicks the specified item on the toolbar. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| RightClick | Right-clicks the object. |
| Select | Selects the specified item from a list or combo box in a toolbar. |
| Set | Sets the value of a specified toolbar edit box. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Submit | Submits a form. |
| Swipe | Swipes the object. |
| ToString | Returns a string that represents the test object. |
| WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
 Exist | Checks whether the object currently exists in the open application. |
| 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. A long 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. A long 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 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. 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
Click on a Calendar Object (VBScript)
'The following example uses the Click method to click at coordinates 5, 10 on the "Calendar1" calendar object.
Browser("Browser").Page("Page").WbfCalendar("Calendar1").Click 5, 10
DoubleClick Method
Description
Clicks on the object twice.
Syntax
object.DoubleClick ([interval], [x], [y])
Arguments
| Parameter | Description |
|---|---|
| interval |
Optional. A double floating value. The number of seconds between the two clicks. The default value is 0.2 seconds. |
| x |
Optional. A long integer value. The x-coordinate of the click. 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. A long integer value. The y-coordinate of the click. 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 |
Return Type
None.
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
If you are testing a web or hybrid application on a mobile device, this method is equivalent to performing the DoubleTap gesture.
Example
Double click a Calendar Object (VBScript)
'The following example double-clicks the "Calendar1" calendar object.
Browser("Browser").Page("Page").WbfCalendar("Calendar1").DoubleClick
Drag Method
Description
Performs the 'drag' part of a drag and drop operation.
Syntax
object.Drag [x], [y], [BUTTON], [Modifier]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. Default value = -9999 |
| y |
Optional. A long integer value. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. Default value = micLeftBtn |
| Modifier |
Optional. A String value. Default value = 0 |
Return Type
None
Drop Method
Description
Performs the 'drop' part of a drag and drop operation.
Syntax
object.Drop [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. Default value = -9999 |
| y |
Optional. A long integer value. Default value = -9999 |
Return Type
None
FireEvent Method
Description
Triggers an event.
Syntax
object.FireEvent EventName, [x], [y], [BUTTON]
Arguments
| Parameter | Description |
|---|---|
| EventName |
Required. A String value. The name of the event to trigger. All events exposed by the Dynamic HTML (DHTML) Object Model are supported. Refer to the DHTML Events section of the MSDN Library documentation for further information. |
| x |
Optional. A long integer value. The x-coordinate, relative to the upper left corner of the object. Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate, relative to the upper left corner of the object. Default value = -9999 |
| BUTTON |
Optional. A predefined constant or number. The mouse button used to fire the object. Default value = micLeftBtn |
Return Type
None
Example
Simulate the Mouseover Event on a Calendar (VBScript)
'The following example uses the FireEvent method to simulate the mouseover event on a calendar object.
Browser("Browser").Page("Page").WbfCalendar("Calendar1").FireEvent "onmouseover"
GetItem Method
Description
Returns the name of the toolbar item specified by its index.
Syntax
object.GetItem (Index)
Arguments
| Parameter | Description |
|---|---|
| Index |
Required. A long integer value. Numeric index of the toolbar item. Index values begin with 0. |
Return Type
A String value.
IMPORTANT
If a toolbar item does not have a name, this method returns its index in text format "#index".
Example
Search for a Specified Item in a Toolbar (VBScript)
'The following example uses the GetItem method to iterate through the toolbar items, search for an item named
'"New", and press it if found.
ItemsCount = Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").GetROProperty("items count")
For i = 0 To ItemsCount - 1
ItemName = Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").GetItem(i)
If ItemName = "New" Then
Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").Press ItemName
Exit For
End If
Next
HoverTap Method
Description
When hover is supported, places the pointer on the object. Otherwise, taps the object.
Syntax
object.HoverTap ([x], [y])
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. The x-coordinate of the hover point or tap. 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. A long integer value. The y-coordinate of the hover point or tap. 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 |
Return Type
None.
IMPORTANT
This method is supported as long as the Web site being tested is run on a mobile device on Digital Lab, and the test object implements this gesture. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
Example
Hover Over or Tap a Checkbox (VBScript)
'When performed in an environment that supports hovering, such as a desktop browser,
'the following example hovers over the checkbox, perhaps displaying a tooltip.
'When performed in an environment that does not support hovering, such as a mobile
'browser, the example taps the checkbox instead, perhaps selecting it.
Browser("Booking Site").Page("Find Flights").WbfCalendar("roundtrip").HoverTap
LongPress Method
Description
Presses and holds the object.
Syntax
object.LongPress [duration], [x], [y]
Arguments
| Parameter | Description |
|---|---|
| duration |
Optional. A double floating value. The time period (in seconds) to hold the long tap gesture. You can specify partial seconds as a duration time. Default value = 1 |
| x |
Optional. A long integer value. The x-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
| y |
Optional. A long integer value. The y-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object. Default value = -9999 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
MiddleClick Method
Description
Middle-clicks the object.
Syntax
object.MiddleClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. The x-coordinate of the middle-click. 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. A long integer value. The y-coordinate of the middle-click. 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 |
Return Type
None
Pan Method
Description
Perform a pan gesture.
Syntax
object.Pan (deltaX, deltaY, [duration], [startX], [startY])
Arguments
| Parameter | Description |
|---|---|
| deltaX |
Required. A long integer value. The distance moved on the x axis, relative to the start point. |
| deltaY |
Required. A long integer value. The distance moved on the y axis, relative to the start point. |
| duration |
Optional. A double floating value. The number of seconds required to perform the pan gesture. Default value = 0.5 |
| startX |
Optional. A long integer value. The x-coordinate of where the pan gesture starts. 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 |
| startY |
Optional. A long integer value. The y-coordinate of where the pan gesture starts. 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 |
Return Type
None.
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported in Internet Explorer and older versions of FireFox
Example
Pan across a WbfCalendar Object (VBScript)
'The following example performs a Pan gesture on a WbfCalendar object.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").WbfCalendar("Calendar1").Pan 564, 507
Pinch Method
Description
Perform a pinch gesture.
Syntax
object.Pinch (scale, [duration], [x], [y])
Arguments
| Parameter | Description |
|---|---|
| scale |
Required. A double floating value. The zoom scale resulting from the pinch gesture. This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture. |
| duration |
Optional. A double floating value. The number of seconds required to perform the pinch gesture. The default value is 1 second. Default value = 1 |
| x |
Optional. A long integer value. The x-coordinate of where the pinch gesture begins. 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. A long integer value. The y-coordinate of of where the pinch gesture begins. 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 |
Return Type
None.
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported in Internet Explorer and older versions of FireFox.
Example
Pinch to zoom in on a WbfCalendar object (VBScript)
'The following example performs a Pinch gesture on a WbfCalendar object, where the zoom is multiplied by 2.5.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").WbfCalendar("Calendar1").Pinch 2.5
Press Method
Description
Clicks the specified item on the toolbar.
Syntax
object.Press (Item)
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A String value. The toolbar item to press. The item name (with quotes) or numeric index (with quotes and preceded by #) can denote the button. Only items in the toolbar that can be pressed are counted for the index. The name reflects the item's attached text (tooltip). The index of the first item in the toolbar is 0. |
Return Type
None.
Example
Press the Specified Toolbar Item (VBScript)
'The following example uses the Press method to press the toolbar item named "Open".
Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").Press "Open"Press the Third Toolbar Item (VBScript)
'The following example uses the Press method to press the third toolbar item.
Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").Press "#2"
RightClick Method
Description
Right-clicks the object.
Syntax
object.RightClick [x], [y]
Arguments
| Parameter | Description |
|---|---|
| x |
Optional. A long integer value. The x-coordinate of the right-click. 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. A long integer value. The y-coordinate of the right-click. 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 |
Return Type
None
Select Method
Description
Selects the specified item from a list or combo box in a toolbar.
Syntax
object.Select (Index, Value)
Arguments
| Parameter | Description |
|---|---|
| Index |
Required. A long integer value. Numeric index of the toolbar item that contains the selection list. Only selectable list items in the toolbar are counted for the index (meaning only items that contain a control such as a list box or combo box). The index of the first item in the toolbar is 0. |
| Value |
Required. A String value. The value to be selected in the specified toolbar item. The value can be either the text of the inner list/combo box item, or its index position (preceded by #). The first item in a list is numbered 0. |
Return Type
None.
Example
Select a Specified Item from a Toolbar List (VBScript)
'The following example uses the Select method to select the "ListItem4" option from the first selectable list
'item in the toolbar.
Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").Select 0, "ListItem4"
'or
Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").Select 0, "#3"
Set Method
Description
Sets the value of a specified toolbar edit box.
Syntax
object.Set (Index, Value)
Arguments
| Parameter | Description |
|---|---|
| Index |
Required. A long integer value. Numeric index of the toolbar item that contains the edit field. Only editable list items in the toolbar are counted for the index (meaning only items that contain an edit box). Index values begin with 0. |
| Value |
Required. A String value. The value to be entered in the specified toolbar edit box. |
Return Type
None.
Example
Enter Specified Text in a Toolbar Item (VBScript)
'The following example uses the Set method to enter the text "NewValue" in the first editable item in the toolbar.
Browser("Browser").Page("WebControls:").WbfToolbar("Toolbar1").Set 0, "NewValue"
Submit Method
Description
Submits a form.
Syntax
object.Submit
Return Type
None.
Example
Submit a Calendar's Form (VBScript)
'The following example uses the Submit method to submit a form in which a calendar is located.
Browser("Browser").Page("Page").WbfCalendar("Calendar1").Submit
Swipe Method
Description
Swipes the object.
Syntax
object.Swipe direction, [distance], [duration], [startX], [startY]
Arguments
| Parameter | Description |
|---|---|
| direction |
Required. A MoveDirection Value. The direction of the swipe gesture. Possible values:
|
| distance |
Optional. A long integer value. The distance (in pixels) of the swipe gesture. Default value = 200 |
| duration |
Optional. A double floating value. The time period (in seconds) of the swipe gesture. You can specify partial seconds as a duration time. Default value = 0.25 |
| startX |
Optional. A long integer value. The x-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object. Default value = -9999 |
| startY |
Optional. A long integer value. The y-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object. Default value = -9999 |
Return Type
None
IMPORTANT
This method is supported as long as the application supports touch events and is run on a mobile device on Digital Lab or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.
This method is not supported on Windows Phone.
Example
Swipe a Toolbar Object (VBScript)
'The following example performs a Swipe gesture on a WbfToolbar object.
Device("Device").App("Mobile Web_2").MobileWebView("Web View").WbfToolbar("Toolbar1").Swipe 1,75,75
See also:
