wButtonID Property (ToolBar and MenuBar Controls)

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

Description

The wButtonID returns the identifier of a control’s item, that is specified by an index or name.

Declaration

TestObj.wButtonID(Item)

Read-Only Property Integer
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    

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

Item

Specifies the desired item. You can enter the item’s index (from 0) or its caption. 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.

Property Value

An integer value that represents the id of the specified control’s item.

If the specified item is not found, wButtonID returns -100.

Remarks

If you use Python or DelphiScript, you should enclose the parameter of the wButtonID property in square brackets: wButtonID[Item].

See Also

Addressing Toolbar Buttons
wButtonPos Property (ToolBar and MenuBar Controls)
wButtonCount Property (ToolBar and MenuBar Controls)
wButtonText Property (Specific to Win32, MFC ToolBar and MFC MenuBar Controls)

Highlight search results