WaitForText Method (String, Int32, Int32, Int32, Int32, Int32, Int32, )

CitrixVirtualUserScript 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.5.7.98

Syntax

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

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

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

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.

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

Exceptions

Exception	Condition
TimeoutException	Thrown 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.