Get OCR Text
Reads the text shown in an element, window or page by OCR.
Behaviour
Risk: None · Idempotent: Yes · Safe to retry: Yes · Recovery: Not replayed after a crash
Package UI Automation activities VeloPhex.UIAutomation.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.ui.getOcrText
Windows · Needs an interactive desktop session
Properties#
Input#
Target#
Target · String · Optional · Default: Not specified in package metadata
The element or region to read. Empty reads the session's first window, or a browser session's active page.
Session#
Session · String · Optional · Default: Not specified in package metadata
The session id from a Use Application/Browser scope. Empty uses the enclosing scope's session, or outside a scope the most recent matching session.
Timeout (seconds)#
TimeoutSeconds · Int32 · Optional · Default: Not specified in package metadata
How long to keep looking for the element or window. Empty or not positive means the same as the enclosing Use Application/Browser scope, or outside a scope the project default (30 seconds).
Highlight before action#
HighlightBeforeAction · Boolean · Optional · Default: Not specified in package metadata
Draw the highlight around the element before acting on it.
Options#
OCR engine#
Engine · String · Optional · Default: windows · Advanced
windows: the OCR built into Windows (offline; the language must be installed with its optical character recognition feature). paddle: PaddleOCR (offline, Latin script; needs the VeloPhex.UIAutomation.Ocr.Paddle package in the project).
Allowed values: windows, paddle.
Language#
Language · String · Optional · Default: Not specified in package metadata · Advanced
The language of the text, as a tag such as en-US or de-DE. Empty uses the Windows display languages of the user running the workflow.
Target values#
TargetValues · IReadOnlyDictionary<String, String> · Optional · Default: Not specified in package metadata · Advanced
Values for the {{name}} slots in the target's attributes, e.g. a dictionary with "invoice" for {{invoice}}. Values are matched as literal text.
Output#
Text#
Text · String · Output
The text read, one line per line of text on screen.
Rules#
- Must be inside Use Application/Browser.
Retry and risk#
This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.
Every activity also has the engine's common properties: Timeout and Continue On Error.
Related activities#
- Capture Screenshot
- Check App State
- Choose Option
- Click
- Click Text
- Drag and Drop
- Element Exists
- Extract Table Data
Generated from VeloPhex.UIAutomation.Activities 0.7.1-rc.12. Category: UI Automation › Element. Keywords: ui, automation, ocr, text, screen.
Properties
Input
Options
Output
Rules
Retry and risk
Related activities