This method is not supported in web tests (including cross-platform web tests) that use XPath expressions and CSS selectors to locate web elements. This method can be only used in tests that locate web objects by using internal identification properties provided by TestComplete.

Description

ClickItem moves the mouse pointer to the control's item and then simulates a single click, subject to the conditions set by the optional parameters.

Declaration

TestObj.ClickItem(Item, By Position, Shift)

TestObj	A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Item	[in]	Required	Variant
By Position	[in]	Optional	Boolean	Default value: True
Shift	[in]	Optional	TShiftKey	Default value: skNoShift
Result	None

Applies To

The method is applied to the following objects:

jQuery UI Buttonset, MFC Menu Bar, MFC Toolbar, Win32 ToolBar

View Mode

This method is available in the Object Browser panel and in other panels and dialogs in both Basic and Advanced view modes.

Parameters

The method has the following parameters:

Item

Specifies the item you want to click. You can specify the item using the item’s caption, id or position in the control. For more information, see the Remarks section.

By Position

Sets whether the Item parameter holds the item’s id or position in the control. For more information, see the Remarks section.

Shift

Specifies whether the CTRL, ALT or SHIFT keys will be pressed during the click. The default value is skNoShift (no shift key pressed). See TShiftKey.

Result Value

None.

Remarks

You can specify the desired control’s item by assigning item’s caption, identifier or position on the control to the Item parameter. Therefore, if this parameter holds a string, TestComplete identifies the item by caption. When Item specifies the caption, you can use wildcards (* and ?) or regular expressions to mark variable parts of the caption. The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting. If Item holds an integer value, then TestComplete checks the ByPosition parameter to determine in what way to identify the item: if ByPosition is True, TestComplete treats the Item value as the item position; if ByPosition is False, TestComplete treats the Item value as an identifier.
If the specified item does not exist, ClickItem fails and posts an error message to the test log.
If the click is allowed and Shift is specified, then it is simulated with the shift keys in the state specified by Shift.
In the Microsoft Edge browser, TestComplete sometimes fails to simulate the ClickItem action against jQuery controls.

Example

To view an example that demonstrates how to use the ClickItem action, see Selecting Toolbar Buttons.

Selecting Toolbar Buttons
ClickItem Action (ToolBar Controls)
ClickItem Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
ClickItemR Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
ClickItemRXY Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
ClickItemXY Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
DblClickItem Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
DblClickItemR Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
wButtonPos Property (ToolBar and MenuBar Controls)
wButtonID Property (ToolBar and MenuBar Controls)
wButtonText Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)

ClickItem Action (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)