Skip to main content
Version: 0.24.0

Recognized UI Elements

The detection model processes a screenshot and returns the elements that are suitable for interaction. Run Teach robot (Shift+E) in the robot live view to see what it found, then right-click an element to build an action around it.

Common settings

Every recognized element shares these fields. Find method, Element index and Strict live in the Advanced options group — turn on Settings → General → Always show additional options if you want them expanded by default.

ParameterDescription
LabelText of the target element. For a Text object this is its own content; for an Input, CheckBox or Icon it is the label next to the control. Accepts variables.
Find methodHow the label is matched. Default AUTO. See the table below.
Element indexWhen several elements match, which one to take — indexed from 0, left-to-right then top-to-bottom. Negative values count from the end (-1 is the last match). Empty means "expect exactly one match".
StrictWhen off and the requested type is not found, the Editor retries as a plain Text object with the same label. Turn it on to require the exact type. Default off. Not available on Text.

Find methods

One comparison method is always active; the flags can be combined with it.

MethodBehaviour
AUTOTries several methods and picks the one that matches. The default — right for most cases.
DYNAMICMatches each word separately, so Hello world is found inside Hi Hello world !. Can be combined with EQUAL or SIMILAR.
EQUALThe whole string must match character for character.
SUBSTRINGThe label must appear as a substring of the on-screen text.
SIMILARSimilarity-based match that tolerates small OCR deviations.
REGEXThe on-screen text must match the regular expression.
FlagBehaviour
CASE_SENSITIVEMakes the comparison case-sensitive. Text is matched case-insensitively by default. Ignored for REGEX.
EXCLUSIVEMatches only elements that contain the specified text and nothing else.
GLOBALReturns every occurrence in a line, not just the first.
USER_NORMALIZATIONApplies the custom text normalization defined for the project before comparing — useful for fixing recurring OCR confusions such as O versus 0.
warning

EXCLUSIVE and GLOBAL are mutually exclusive — you can use at most one of them. CASE_INSENSITIVE is deprecated and has no effect; matching is case-insensitive unless you add CASE_SENSITIVE.


UI elements

Text – any visible text. The most common and most forgiving object.

Text search object

Button, CheckBox, RadioButton – standard interactive controls.

CheckBox also covers on/off switches (toggles). There is no separate Toggle entry in the Search object dropdown — pick CheckBox and give it the switch's label.

CheckBox search object targeting an on/off switch

In the screenshot above, CheckBox with the label Spoken answers targets a switch control on a settings page.

Icon – UI icons, identified through the text next to them.

Input, TextArea – input fields; the nearest label identifies the field.

Input search object

Image – a picture you supply, matched by similarity. Load it from a file, the clipboard, or by cropping the live view.

ParameterDescription
ImageThe reference bitmap to look for.
ThresholdSimilarity required for a match, 01. Default 0.85. Lower it if the image is not found, raise it if the wrong thing matches.
Element indexWhich occurrence to take when the image appears several times.

Image search object

tip

Prefer text-based objects over Image whenever the element has any readable label — image matching breaks on theme changes, DPI scaling and re-styling.