highlightObject

highlightObject(objectOrName, [timeoutMSec, [block]])

highlightObject(screenRectangle, [timeoutMSec, [block]])

This function highlights the screen position of the object specified by objectOrName or the rectangle specified by screenRectangle through a red rectangle.

The red overlay will remain on the screen for 3 seconds unless overridden by the optional timeoutMSec parameter.

Test execution will be blocked during highlighting unless overridden by the optional block parameter with a false value.

Such a visual confirmation can be helpful if there is doubt as to whether an object found through an object lookup function is the correct one. Similarly, it can be used to verify if area defined by screenRectangle is as intended.