CitrixVirtualUser WaitForImage Method (String, Int32, Int32, Int32, Int32, Int32, Int32)C# API
Wait for an image 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 WaitForImage(
	string bitmapFile,
	int xPos,
	int yPos,
	int width,
	int height,
	int searchRadius,
	int timeout
)

Parameters

bitmapFile
Type: System String
The image to be found
xPos
Type: System Int32
the x coordinate of the top left hand corner of the search area
yPos
Type: System Int32
the y coordinate of the top left hand corner of the search area
width
Type: System Int32
the width of the search area
height
Type: System Int32
the height of the search area
searchRadius
Type: System Int32
increase the search area by searchRadius pixels in each direction
timeout
Type: System Int32
The total time in milliseconds to wait before timing out.

Return Value

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

ExceptionCondition
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

// 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);
See Also