GetButtonImage Event

Applies to TestComplete 15.42, last modified on August 01, 2022

Occurs when the in-place editor requests the image of a specific button.


GetButtonImage(DataIndex) Parameters
Data [in] Required Object
Index [in] Required Integer
Result     String  


Custom keyword test operations can use text box in-place editors with a number of embedded buttons. By default, these buttons have the ellipsis drawn on it. If you want to use a custom image for a particular button, use the GetButtonImage event handler to specify the desired image.

The button images must reside in the script extension package. They must be 14×14 BMP or PNG files with the 24-bit or lower color depth. The color of the leftmost-bottom pixel is treated as transparent.


The event has the following parameters:


An object that provides access to the operation fields. This object contains properties that correspond to individual operation fields and whose names coincide with the field names.


A zero-based index of the editor’s button. Buttons are indexed from left to right.

Return Value

A string holding the name and extension (without the path) of the BMP or PNG file that contains the button image.

See Also

Events Reference
GetButtonCount Event
OnButtonClick Event
Creating Keyword Test Operations

Highlight search results