WaitForImage Method (String)

CitrixVirtualUserScript WaitForImage Method (String)

C# API

Wait for an image to appear anywhere on the screen

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

Syntax

public Rectangle WaitForImage(
	string image
)

public Rectangle WaitForImage(
	string image
)

Parameters

image: Type: System String
The image to be found

Return Value

The rectangle where the image was found. This value is also copied to LastFoundLocation

Exceptions

Exception	Condition
TimeoutException

Remarks

The call searches for the image (bitmap) until it is is found or the timeout period expires and a TimeoutException is raised.

Examples

C++

Copy to Clipboard Print

// Wait for the NewItem.bmp image to appear in the given X,Y,width,height screen area. 
// DefaultSearchRadius, DefaultTimeout and DefaultPollFrequency apply to this call

WaitForImage("NewItem", 120, 150, 10, 12);
Rectangle NewItem = LastFoundLocation; // save the location of the image 

// Click 50 pixels to the right of the image 
Click(NewItem.Right + 50, NewItem.Top + 10);

// Wait for the NewItem.bmp image to appear in the given X,Y,width,height screen area. 
// DefaultSearchRadius, DefaultTimeout and DefaultPollFrequency apply to this call

WaitForImage("NewItem", 120, 150, 10, 12);
Rectangle NewItem = LastFoundLocation; // save the location of the image 

// Click 50 pixels to the right of the image 
Click(NewItem.Right + 50, NewItem.Top + 10);