IconButton

Description

Special Button that moves the mouse away after clicking. Also could be used for icons with tool tips, if we ever need to interact with a tool tip.

IconButton Class

Namespace: Progile.TRIO.BaseModel Assembly: Progile.TRIO.BaseModel (in Progile.TRIO.BaseModel.dll)

Inheritance Hierarchy:

Object Progile.TRIO.BaseModel.OnScreenElement Progile.TRIO.BaseModel.Button Progile.TRIO.BaseModel.IconButton

Constructors

IconButton(ITester, string, ImageReference, IImageFilter[ ])

Creates a new IconButton instance, that can be found with an image search for the imageReference within the provided filters. If button has active and inactive states, use the constructor with both activeImageReference and inactiveImageReference parameters instead.

Syntax:

public IconButton(
	ITester tester,
	string displayName,
	ImageReference imageReference,
	params IImageFilter[] filters
)

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the element that will be used for logging and reporting of exceptions (customer facing).
imageReference	Type: ImageReference The image reference that will be used to locate the button on the screen.
[filters]	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image searches.

IconButton(ITester, string, ImageReference, ImageReference, IImageFilter[ ])

Creates a new IconButton instance, that can be found with an image search for either the active or inactive image reference within the provided filters. The active and inactive image references are used to check for the button state with IsActive, WaitForActive and WaitForInactive.

Syntax:

public IconButton(
	ITester tester,
	string displayName,
	ImageReference activeImageReference,
	ImageReference inactiveImageReference = null,
	params IImageFilter[] filters
)

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the element that will be used for logging and reporting of exceptions (customer facing).
activeImageReference	Type: ImageReference The active image reference that will be used to locate the button on the screen.
[inactiveImageReference]	Type: ImageReference The inactive image reference of the button. Will also be used to locate the button on the screen.
[filters]	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image searches.

IconButton(ITester, string, string, IImageFilter[ ])

Creates a new IconButton instance, that can be found with a text search for searchText within the provided filters.

Syntax:

public IconButton(
	ITester tester,
	string displayName,
	string searchText,
	params IImageFilter[] filters
)

Parameter	Description
tester	Type: ITester The tester interface.
displayName	Type: String The name of the element that will be used for logging and reporting of exceptions (customer facing).
serachText	Type: String The searchText that will be used to locate the button on the screen.
[filters]	Type: IImageFilter[ ] Typically a Select filter indicating the area of interest for the image searches.

Properties

Name	Description
LeaveOffset	Configure how much the mouse should move away after clicking. If it's empty point, the mouse doesn't move. Default is the same as the MouseClickApproachOffset.