CitrixVirtualUser WaitForText Method (String, Int32, Int32, Int32, Int32, Int32, Int32, )C# API
Use OCR to wait for some text to appear in an area of the screen.

Namespace: Facilita.Fc.Citrix
Assembly: fcCitrix (in fcCitrix.dll) Version: 9.4.0.26
Syntax

public Rectangle WaitForText(
	string searchText,
	int x,
	int y,
	int width,
	int height,
	int pollFrequency,
	int timeout,
	OCROptions ocrOptions
)

Parameters

searchText
Type: System String
the text to find
x
Type: System Int32
The x coordinate of the top left corner of the rectangle to read
y
Type: System Int32
The y coordinate of the top left corner of the rectangle to read
width
Type: System Int32
The width of the rectangle to read
height
Type: System Int32
The height of the rectangle to read
pollFrequency
Type: System Int32
The time in milliseconds between attempts to read the OCR text
timeout
Type: System Int32
The total time in milliseconds to wait before timing out.
ocrOptions
Type: OCROptions
The OCR options to use

Return Value

A Rectangle specifying the area of the screen where the text was found
Exceptions

ExceptionCondition
TimeoutExceptionThrown if the text cannot be found before the timeout period elapses
Remarks

This method will search for the text every pollFrequency milliseconds until the text can be found, or until the search times out.
See Also