wIsCheckButton Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)

Applies to TestComplete 14.80, last modified on April 20, 2021

Description

Use the wIsCheckButton property to determine whether a control item has the TBSTYLE_CHECK or BTNS_CHECK style.

Declaration

TestObj.wIsCheckButton(ItemBy 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 either caption or identifier of the desired item, or its position on the control (from 0). For more information, see the Remarks section.

By Position

Specifies whether the Item parameter specifies the identifier or position of the item. For more information, see the Remarks section. If Item holds a string, the ByPosition parameter is ignored.

Property Value

True, if button Item has the Check style. Otherwise - False. If the specified 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 wlsCheckButton property in square brackets: wlsCheckButton[Item, ByPosition].

Example

To view an example that demonstrates how to use the wIsCheckButton property, see Checking the Toolbar Buttons' Type.

See Also

Checking the Toolbar Buttons' Type
wIsCheckButton Property (ToolBar Controls)
wChecked Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
wIsDropDownButton Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)
wIsSeparatorButton 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)

Highlight search results