wHotImage Property (ToolBar and MenuBar Controls)

Applies to TestComplete 15.64, last modified on May 16, 2024


Use the wHotImage property to get the image that corresponds to the hot state of the specified control button. A control button is in the hot state when the cursor is located over it. To get button images for the normal or disabled state use wImage and wDisabledImage properties.


TestObj.wHotImage(Item, By Position)

Read-Only Property A Picture object
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.


The property has the following parameters:


Specifies the caption, identifier or position on the control (from 0) of the desired item. For more information, see the Remarks section below.

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

A Picture object that contains the button’s image.


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 wHotImage property in square brackets: wHotImage[Item, ByPosition].

See Also

wImage Property
wDisabledImage Property
wButtonID Property
wButtonCount Property
wButtonPos Property

Highlight search results