LabelWithButton
Namespace: Progile.TRIO.BaseModel
Assembly: Progile.TRIO.BaseModel (in Progile.TRIO.BaseModel.dll)
Object
Progile.TRIO.BaseModel.OnScreenElement
Progile.TRIO.BaseModel.LabelWithElementBase
Progile.TRIO.BaseModel.LabelWithButton
Initializes a new instance of the LabelWithButton class.
Syntax:
public LabelWithButton(
ITester tester,
string displayName,
RelativePosition buttonPosition,
ImageReference imageReferenceForLabel,
ImageReference imageReferenceForButton,
int gridWidth = 0,
int buttonLineHeight = 0,
params IImageFilter[] filters
)
Parameter | Description |
tester | The tester interface. |
displayName | Type: String
The name of the button that will be used for logging and reporting of exceptions (customer facing). |
buttonPosition | |
imageReferenceForLabel | |
imageReferenceForButton | The image reference that will be used to locate the button on the screen. |
[gridWidth] | Type: Int32
The minimum width that contains both the label and the button, typically the width of the UI grid column.
(Note: ensure the width fits with all window sizes that need to be supported) The gridWith needs to be set for buttonPosition Left or Right |
[buttonLineHeight] | The minimum Height of the line with the button. The buttonLineHeight needs to be set for buttonPosition Above or Under |
[filters] | The filters to find the label. |
Exception | Condition |
ArgumentException | buttonLineHeight needs to be set if buttonPosition is Above or Under;
gridWidth needs to be set if buttonPosition is Left or Right |
Syntax:
public LabelWithButton(
ITester tester,
string displayName,
RelativePosition buttonPosition,
ImageReference imageReferenceForLabel,
ImageReference buttonActiveimageReference,
ImageReference buttonInactiveImageReference,
int gridWidth = 0,
int buttonLineHeight = 0,
params IImageFilter[] filters
)
Parameter | Description |
tester | The tester interface. |
displayName | Type: String
The name of the button that will be used for logging and reporting of exceptions (customer facing). |
buttonPosition | |
imageReferenceForLabel | |
buttonActiveimageReference | The active image reference that will be used to locate the button on the screen. |
buttonInactiveImageReference | The inactive image reference of the button. Will also be used to locate the button on the screen. |
[gridWidth] | Type: Int32
The minimum width that contains both the label and the button, typically the width of the UI grid column.
(Note: ensure the width fits with all window sizes that need to be supported) The gridWith needs to be set for buttonPosition Left or Right |
[buttonLineHeight] | The minimum Height of the line with the button. The buttonLineHeight needs to be set for buttonPosition Above or Under |
[filters] | The filters to find the label. |
Exception | Condition |
ArgumentException | buttonLineHeight needs to be set if buttonPosition is Above or Under;
gridWidth needs to be set if buttonPosition is Left or Right |
Syntax:
public LabelWithButton(
ITester tester,
string displayName,
RelativePosition buttonPosition,
string searchTextForLabel,
string searchTextForButton,
int gridWidth = 0,
int buttonLineHeight = 0,
params IImageFilter[] filters
)
Parameter | Description |
tester | The tester interface. |
displayName | Type: String
The name of the button that will be used for logging and reporting of exceptions (customer facing). |
buttonPosition | |
searchTextForLabel | |
searchTextForButton | The search text that will be used to locate the button on the screen. |
[gridWidth] | Type: Int32
The minimum width that contains both the label and the button, typically the width of the UI grid column.
(Note: ensure the width fits with all window sizes that need to be supported) The gridWith needs to be set for buttonPosition Left or Right |
[buttonLineHeight] | The minimum Height of the line with the button. The buttonLineHeight needs to be set for buttonPosition Above or Under |
[filters] | The filters to find the label. |
Exception | Condition |
ArgumentException | buttonLineHeight needs to be set if buttonPosition is Above or Under;
gridWidth needs to be set if buttonPosition is Left or Right |
Name | Description |
Clicks on the button. Verifies the click was successful with the specified verification and performs retries if necessary. | |
Performs a double click on the button. Wait time between the individual clicks is controlled by the optional parameter doubleClickDelay. | |
Moves the mouse over the button. Verifies the hover was successful with the specified verification and performs retries if necessary. | |
Checks the state of the button. Returns true if the button is active, false if the button is inactive. Requires that images named "active" and "inactive" are present in the folder given as content. | |
Waits for the active status of the button. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds. | |
Waits for the inactive status of the button. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds. |
Last modified 2yr ago