Method ocr.wait

Overload

Performs OCR (text recognition) and finds text in results. Waits until found.

public static ocr wait(Seconds timeout, IFArea area, string text, OcrFlags flags = 0, double scale = 0, IOcrEngine engine = null, int skip = 0)
Parameters
timeout  (Seconds)

Timeout, seconds. Can be 0 (infinite), >0 (exception) or <0 (no exception). More info: Wait timeout.
area  (IFArea)

On-screen area or image:

  • wnd - window or control (its client area).
  • elm - UI element.
  • System.Drawing.Bitmap - image.
  • RECT - a rectangle area in screen.
  • IFArea - can contain wnd, elm or Bitmap. Also allows to specify a rectangle in it, which makes the area smaller and the function faster. Example: new(w, (left, top, width, height)).
text  (string)

Text to find in ocr.TextForFind. Can have prefix:

  • "**r " - PCRE regular expression. Example: @"**r \bwhole words\b".
  • "**R " - .NET regular expression.
  • "**i " - case-insensitive.
  • "**t " - case-sensitive (default).
flags  (OcrFlags)
scale  (double)

Scale factor (how much to resize the image before performing OCR). Value 2 or 3 may improve results of OCR engine OcrWin10 or OcrTesseract. If 0 (default), depends on engine's IOcrEngine.DpiScale and area's DPI.
engine  (IOcrEngine)

OCR engine. Default: ocr.engine (OcrWin10 if not specified).
skip  (int)

Skip this count of found text instances.
Returns
ocr

Returns an ocr object that contains the word index and can click it etc. On timeout returns null if timeout is negative; else exception.
Exceptions
TimeoutException

timeout time has expired (if > 0).
AuWndException

Invalid window handle (the area argument), or the window closed while waiting.
ArgumentException

An argument is/contains a null/invalid value.
AuException

Something failed.

Remarks

The function captures image from screen or window (unless area is Bitmap) and passes it to the OCR engine (calls IOcrEngine.Recognize). Then finds the specified text in results. If found, creates and returns an ocr object that contains results.

The speed depends on engine, area size and amount of text.