CheckButton Action (Specific to QtToolButton Controls)

Applies to TestComplete 14.91, last modified on July 20, 2021

Description

Moves the mouse pointer to a tool button and then sets its state according to the Checked parameter.

Declaration

TestObj.CheckButton(Checked)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Checked [in]    Required    Variant    
Result None

Applies To

The method is applied to the following object:

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

Checked

Specifies the tool button state to be set. It takes the following values:

Value Description
cbChecked, True or 1 The tool button becomes checked.
cbUnchecked, False or 0 The tool button becomes unchecked.

Result Value

None.

Remarks

If the tool button is not checkable, the method fails and posts an error message to the test log. To determine whether the tool button is checkable, use the wIsCheckButton property.

If the Checked parameter corresponds to the current Tool button state (for example, the Checked parameter value is cbChecked and the tool button is already checked), the method performs no action and reports that the operation was executed successfully in the test log. To determine the current state of the tool button, use the wChecked property.

See Also

wIsCheckable Property (Specific to QtToolButton Controls)
wChecked Property (Specific to QtToolButton Controls)

Highlight search results