Description
Use the wChecked property to determine whether the control item specified by the Item parameter is checked or unchecked.
Declaration
TestObj.wChecked(Item, By Position)
| Read-Only Property | Boolean |
| 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: False |
Applies To
The property is applied to the following objects:
View Mode
To view this property in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.
Parameters
The property has the following parameters:
Item
Specifies the control item whose state you want to obtain. You can specify the item using its caption, identifier or position on the control (from 0). For more information, see the Remarks section.
By Position
Specifies whether the Item parameter holds the identifier or position of the control item. For more information, see the Remarks section. ByPosition is meaningful only when Item holds an integer value. Otherwise, ByPosition is ignored.
Property Value
True, if the specified item is checked, or False, if the item is unchecked. If the item was not found, the property will also return False.
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 you use Python or DelphiScript, you should enclose the parameters of the wChecked property in square brackets: wChecked[Item, ByPosition].
Example
To view an example that demonstrates how to use the wChecked property, see Checking the Toolbar Buttons’s State
See Also
Checking the Toolbar Buttons' State in Desktop Windows Applications
wChecked Property (ToolBar Controls)
wEllipses Property (ToolBar and MenuBar Controls)
wEnabled Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
wGrayed Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
wVisible Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
wButtonID Property (ToolBar and MenuBar Controls)
wButtonCount Property (ToolBar and MenuBar Controls)
wButtonPos Property (ToolBar and MenuBar Controls)