LabelWithElementBase

Description

Abstract class to combine a label with an other element based on the relative position. Needs to be generically implemented for every element. See LabelWithCheckbox as an example.

LabelWithElementBase Class (abstract)

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

Inheritance Hierarchy:

Object Progile.TRIO.BaseModel.OnScreenElement Progile.TRIO.BaseModel.LabelWithElementBase

Constructors

LabelWithElementBase(ITester, string, RelativePosition, ImageReference, int, int, IImageFilter[ ])

Syntax:

public LabelWithElementBase(
	ITester tester,
	string displayName,
	RelativePosition elementPosition,
	ImageReference imageReferenceForLabel,
	int gridWidth,
	int lineHeight,
	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).
elementPosition	Type: Progile.TRIO.BaseModel.RelativePosition The position of the element relative to the label.
imageReferenceForLabel	Type: ImageReference The reference to the image that will be used to locate the element on the screen.
gridWidth	Type: Int32 The minimum width that contains both the label and the checkbox, typically the width of the UI grid column. (Note: ensure the width fits with all window sizes that need to be supported)
lineHeight	Type: Int32 The minimum Height of the line with the element.
filters	Type: IImageFilter[] The filters to find the label.

Exceptions:

Exception	Condition
ArgumentException	lineHeight needs to be set if elementPosition is Above or Under gridWidth needs to be set if elementPosition is Left or Right

LabelWithElementBase(ITester, string, RelativePosition, string, int, int, IImageFilter[ ])

Syntax:

public LabelWithElementBase(
	ITester tester,
	string displayName,
	RelativePosition elementPosition,
	string searchText,
	int gridWidth,
	int lineHeight,
	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).
elementPosition	Type: Progile.TRIO.BaseModel.RelativePosition The position of the element relative to the label.
searchTextForLabel	Type: String The searchText that will be used to locate the element on the screen.
gridWidth	Type: Int32 The minimum width that contains both the label and the checkbox, typically the width of the UI grid column. (Note: ensure the width fits with all window sizes that need to be supported)
lineHeight	Type: Int32 The minimum Height of the line with the element.
filters	Type: IImageFilter[] The filters to find the label.

Exceptions:

Exception	Condition
ArgumentException	lineHeight needs to be set if elementPosition is Above or Under gridWidth needs to be set if elementPosition is Left or Right

Properties

Name	Description
Margin	The margin that is added to the boundary of the searchresult for the label to define the SearchRectForElement.