Object Model Reference for GUI Testing > .NET Windows Forms > Click Method

SwfToolBar Object

Description

A .NET Windows Forms toolbar.

Operations

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

Note: You can also view a list and descriptions of the SwfToolBar 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 CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks an object.
Method ClickLink Clicks a specified link.
Method Collapse Expands the specified group.
Method DblClick Double-clicks an object
Method Drag Performs the 'drag' part of a drag-and-drop operation.
Method Drop Performs the 'drop' part of a drag-and-drop operation.
Method Expand Expands the specified group.
Method FireEvent Simulates an event on a .NET object.
Method GetContent Returns the names of all of the buttons in a toolbar.
Method GetErrorProviderText Returns the tooltip text of the error icon associated with the object.
Method GetItem Returns the name of the toolbar button specified by its index.
Method GetItemProperty Returns the current value of a property for a toolbar button.
Method GetItemsCount Returns the number of buttons in a toolbar.
Common Method GetROProperty Returns the current value of the description properties from the object in the application.
Method GetSelection Returns a string containing the names of all of the currently selected (pushed) dual-state (toggle) buttons in the toolbar.
Method GetTextLocation Checks whether the specified text string is contained in the specified window area.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method GetVisibleText Returns the text from the specified area.
Method IsItemEnabled Indicates whether the specified toolbar item is enabled.
Method ItemExists Indicates whether the specified toolbar item exists.
Method MouseMove Moves the mouse pointer to the designated position over the object.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method Press Clicks the specified toolbar button.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method Select Selects the specified toolbar item.
Method SelectPage Selects the specified page.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method ShowDropdown Opens the dropdown menu associated with the toolbar button by clicking the arrow part of the button.
Common Method ToString Returns a string that represents the test object.
Method Type Types the specified string in the object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.

 

Back to top

Click Method

Description

Clicks an 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 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


 

Back to top

ClickLink Method

Description

Clicks a specified link.

Syntax

object.ClickLink Item

Arguments

Parameter Description
Item Required. A String value.
The toolbar button name (with quotes) or numeric index (without quotes) can denote the item. The first item in the toolbar is numbered 1.

Return Type

None

IMPORTANT

This method is supported for DevExpress applications only.

Example


 

Back to top

Collapse Method

Description

Expands the specified group.

Syntax

object.Collapse groupName

Arguments

Parameter Description
groupName Required. A String value.
The group name (with quotes).

Return Type

None

IMPORTANT

This method is supported for DevExpress applications only.

Example


 

Back to top

DblClick Method

Description

Double-clicks an 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.
Y Required. An integer value.
The y-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner 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


 

Back to top

Drag Method

Description

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

Syntax

object.Drag X, Y, [BUTTON]

Arguments

Parameter Description
X Required. An integer value.
The coordinates within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The coordinates within the window from which the object is dragged. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The mouse button used to drag the object.


Default value = micLeftBtn

Return Type

None

Example


 

Back to top

Drop Method

Description

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

Syntax

object.Drop X, Y, [BUTTON]

Arguments

Parameter Description
X Required. An integer value.
The coordinates of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The coordinates of the object onto which the object is dropped. Note that the specified coordinates are relative to the upper left corner of the object.
BUTTON Optional. A predefined constant or number.
The button that is released to drop the object.
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

Expand Method

Description

Expands the specified group.

Syntax

object.Expand groupName

Arguments

Parameter Description
groupName Required. A String value.
The group name (with quotes).

Return Type

None

IMPORTANT

This method is supported for DevExpress applications only.

Example


 

Back to top

FireEvent Method

Description

Simulates an event on a .NET object.

Syntax

object.FireEvent (EventName)

Arguments

Parameter Description
EventName Required. A Variant.
The name of the event to simulate. The list of possible events depends on the object.
Required. None
The Args argument is passed to the constructor of the event's EventArgs object or the implementing class. Enter the values in a comma separated list. If no event arguments are required, you do not need to supply a value for the argument.

Return Type

None.

IMPORTANT

The event is sent to all listeners of the .NET object and does not affect the .NET object itself. For example, simulating a click event does not actually perform the click.

Example


 

Back to top

GetContent Method

Description

Returns the names of all of the buttons in a toolbar.

Syntax

object.GetContent

Return Type

A String value.

IMPORTANT

If a toolbar button does not have a name, this method returns its index.

Example


 

Back to top

GetErrorProviderText Method

Description

Returns the tooltip text of the error icon associated with the object.

Syntax

object.GetErrorProviderText

Return Type

A String value.

If no error provider control currently exists for the object, the method returns an empty string.

Example


 

Back to top

GetItem Method

Description

Returns the name of the toolbar button specified by its index.

Syntax

object.GetItem (Index)

Arguments

Parameter Description
Index Required. A Variant.
Numeric index of the button. Index values begin with 1.

Return Type

A String value.

IMPORTANT

If a toolbar button does not have a name, this method returns its index.

Example


 

Back to top

GetItemProperty Method

Description

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

Syntax

object.GetItemProperty (Item, Property)

Arguments

Parameter Description
Item Required. A Variant.
The toolbar button name (with quotes) or numeric index (without quotes) can denote the item. The first item in the toolbar is numbered 1.
Property Required. A String value.
Property to retrieve from the toolbar button. See the table below for a list of supported properties.
 
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 button's text is truncated and an ellipsis (...) is displayed.
Possible values:                                    
       True
       False
enabled
Indicates whether the toolbar button is enabled (accepts user input).
Possible values:                                    
       True
       False
hidden
Indicates whether the toolbar button is not visible and cannot accept user input.
Possible values:                                    
       True
       False
highlighted
Indicates whether the toolbar button is highlighted (surrounded by a dotted line).
Possible values:                                    
       True
       False
hot
Indicates whether the toolbar button is "hot". (A hot toolbar button appears highlighted when the mouse pointer is over it.)
Possible values:                                    
       True
       False
indeterminate
Indicates that the control is neither checked nor unchecked. An indeterminate control generally has a shaded appearance.
Possible values:                                    
       True
       False
index
The index number of the toolbar button. The index does not include hidden and separator buttons.
Index values begin with 0.
marked
Indicates whether the toolbar button is marked. The interpretation of a marked button is application dependent.
Possible values:                                    
       True
       False
name
The name of the toolbar button.
pressed
Indicates whether the toolbar button is currently being clicked.
Possible values:                                    
       True
       False
wrap
Indicates whether the toolbar button is enabled and followed by a line break.
Possible values:                                    
       True
       False

Return Type

A Variant.

Example


 

Back to top

GetItemsCount Method

Description

Returns the number of buttons in a toolbar.

Syntax

object.GetItemsCount

Return Type

A long integer value.

Example


 

Back to top

GetSelection Method

Description

Returns a string containing the names of all of the currently selected (pushed) dual-state (toggle) buttons in the toolbar.

Syntax

object.GetSelection

Return Type

A String value.

IMPORTANT

A selected button is a dual-state (toggle) push button that is currently selected (pushed).

Example


 

Back to top

GetTextLocation Method

Description

Checks whether the specified text string is contained in the specified window area.

Syntax

object.GetTextLocation (TextToFind, Left, Top, Right, Bottom, [MatchWholeWordOnly])

Arguments

Parameter Description
TextToFind Required. A String value.
The text string you want to locate.
Left Required. A Variant.
The left coordinate of the search area within the window or screen.
Top Required. A Variant.
The top coordinate of the search area within the window or screen.
Right Required. A Variant.
The right coordinate of the search area within the window or screen.
Bottom Required. A Variant.
The bottom coordinate of the search area within the window or screen.

Note: Set the Left, Top, Right, and Bottom coordinates to -1 to search for the text string within the object's entire window.

MatchWholeWordOnly Optional. A Boolean value.
If True, the method searches for occurrences that are whole words only and not part of a larger word. If False, the method does not restrict the results to occurrences that are whole words only.
Default value = True

Default value = True

Return Type

A Boolean value.

Indicates whether the text was found in the specified coordinates. Additionally, if the text is found, this method returns the coordinates of the rectangle containing the first instance of the text into the Left, Top, Right, and Bottom arguments.

IMPORTANT

Example


 

Back to top

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

Example


 

Back to top

IsItemEnabled Method

Description

Indicates whether the specified toolbar item is enabled.

Syntax

object.IsItemEnabled (Item)

Arguments

Parameter Description
Item Required. A String value.
The name of the toolbar item to check. For menu items, specify the menu item path using menu item names, separated by a semicolon (;).

Return Type

A Boolean value.

IMPORTANT

This method is implemented for ToolStrip and MenuStrip toolbars only.

Example


 

Back to top

ItemExists Method

Description

Indicates whether the specified toolbar item exists.

Syntax

object.ItemExists (Item)

Arguments

Parameter Description
Item Required. A String value.
The name of the toolbar item to check. For menu items, specify the menu item path using menu item names, separated by a semicolon (;).

Return Type

A Boolean value.

IMPORTANT

This method is implemented for ToolStrip and MenuStrip toolbars only.

Example


 

Back to top

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 position of the mouse pointer, expressed as x-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The position of the mouse pointer, expressed as y-coordinates (in pixels). Note that the specified coordinates are relative to the upper left corner of the object.

Return Type

None

IMPORTANT

The MouseMove method may behave unexpectedly in a VMware environment.

Workaround: Add the following line to the VMware configuration file (<VM name>.vmx): vmmouse.present = "FALSE"
For more information, refer to the VMware support article, number 1691 - "Unexpected Cursor Behavior in Windows Virtual Machine with "Snap To" Mouse Control Panel Option Enabled", at: http://www.vmware.com/support/kb/enduser/std_alp.php.

Example


 

Back to top

Press Method

Description

Clicks the specified toolbar button.

Syntax

object.Press ToolBarButton, [MouseButton]

Arguments

Parameter Description
ToolBarButton Required. A Variant.
The toolbar button to click. The item name (with quotes) or numeric index (without quotes) can denote the button. The name reflects the button's attached text (tooltip). The index of the first item in the toolbar is 0.
MouseButton Optional. A predefined constant or number.
The mouse button that is used to click the item. 0=LEFT, 1=RIGHT, 2=MIDDLE.
Default = 0 (LEFT).
Default value = micLeftBtn

Return Type

None

Example


 

Back to top

Select Method

Description

Selects the specified toolbar item.

Syntax

object.Select Item

Arguments

Parameter Description
Item Required. A String value.
The name or full path of the item to select. For menu items, the path is composed of the menu item names, separated by a semicolon (;).

Return Type

None

IMPORTANT

This method is implemented for ToolStrip and MenuStrip toolbars only.

Example


 

Back to top

SelectPage Method

Description

Selects the specified page.

Syntax

object.SelectPage pageName

Arguments

Parameter Description
pageName Required. A String value.
The name of the page to open in the toolbar.

Return Type

None

IMPORTANT

This method is supported for DevExpress applications only.

Example


 

Back to top

ShowDropdown Method

Description

Opens the dropdown menu associated with the toolbar button by clicking the arrow part of the button.

Syntax

object.ShowDropdown ToolBarButton

Arguments

Parameter Description
ToolBarButton Required. A Variant.
The toolbar button for which you want to show the drop-down item. The button name (with quotes) or numeric index (without quotes) can denote the button. The name reflects the button's attached text (tooltip). The index of the first button in the toolbar is numbered 1.

Return Type

None

Example


 

Back to top

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


Back to top

See also: