Description
Each item of the PropertyGridControl control consists of the label and the data cell. Use the ClickLabel action to simulate a click of the left mouse button on the label of the specified grid item.
Declaration
TestObj.ClickLabel(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 PropertyGridControl, MFC PropertyGrid, Microsoft PropertyGrid, PropertyGridControlItem
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 index or caption of the desired item whose label needs to be clicked.
The index is zero-based, that is, the index of the first item is 0. The index of the last item is wItemCount - 1.
The caption can contain asterisk (*) or question mark (?) wildcards or regular expressions. The asterisk corresponds to a string of any length (including an empty string), the question mark corresponds to any single character (including none). To specify more complicated parts of a caption, use regular expressions.
The caption can be case-sensitive or case-insensitive depending on the value of the Use case-sensitive parameters project setting.
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, ClickLabel fails and posts an error message to the test log.
Example
To view an example that demonstrates how to use the ClickLabel action, see Selecting Items in Microsoft PropertyGrid.
See Also
ClickLabelR Action (Specific to PropertyGrid Controls)
DblClickLabel Action (Specific to PropertyGrid Controls)
DblClickLabelR Action (Specific to PropertyGrid Controls)
ClickValue Action (Specific to PropertyGrid Controls)