Description

The ClickItem action moves the mouse pointer to the ribbon control’s item specified by the Item parameter and then simulates a click over it.

Declaration

TestObj.ClickItem(Item, 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
Shift	[in]	Optional	TShiftKey	Default value: skNoShift
Result	None

Applies To

The method is applied to the following objects:

Developer Express RibbonControl, MFC Ribbon Bar, Microsoft Ribbon, Telerik RadRibbonBar for WinForms

View Mode

To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.

Parameters

The method has the following parameters:

Item

Specifies the path to the desired item. The path should be relative to the current item or to the tree root, respectively. To indicate that the path starts from the tree root, place the pipeline character ( | ) at the beginning of the path.

Each item in the path can be specified by its caption or index; individual captions and indexes must be separated with pipeline characters ( | ). Indexes must be enclosed in brackets - [ and ].

To indicate variable parts of the item caption, you can use the asterisk (*) and question mark (?) wildcards. The asterisk corresponds to a string of any length, the question mark corresponds to any single character. The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.

Note:

If the item caption includes a bracket or a pipeline character, address the item by its index or with the question mark wildcard.

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

If the specified item is not found in the control, ClickItem fails and posts an error message to the test log.

ClickItem Action (Ribbon Controls)