LabelWithButton
Description
Class for buttons that are associated with a static label. Offers same interactions as Button.
LabelWithButton Class
Namespace: Progile.TRIO.BaseModel Assembly: Progile.TRIO.BaseModel (in Progile.TRIO.BaseModel.dll)
Inheritance Hierarchy:
Object Progile.TRIO.BaseModel.OnScreenElement Progile.TRIO.BaseModel.LabelWithElementBase Progile.TRIO.BaseModel.LabelWithButton
Constructors
Initializes a new instance of the LabelWithButton class.
LabelWithButton(ITester, string, RelativePosition, ImageReference, ImageReference, int, int, IImageFilter[ ])
Syntax:
Parameters:
Parameter
Description
tester
Type: ITester
The tester interface.
displayName
Type: String The name of the button that will be used for logging and reporting of exceptions (customer facing).
buttonPosition
Type: Progile.TRIO.BaseModel.RelativePosition The position of the button relative to the label.
imageReferenceForLabel
Type: ImageReference The image reference that will be used to locate the label on the screen.
imageReferenceForButton
Type: ImageReference
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]
Type: Int32
The minimum Height of the line with the button.
The buttonLineHeight needs to be set for buttonPosition Above
or Under
[filters]
Type: IImageFilter[]
The filters to find the label.
Exceptions:
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
LabelWithButton(ITester, string, RelativePosition, ImageReference, ImageReference, ImageReference, int, int, IImageFilter[ ])
Syntax:
Parameters:
Parameter
Description
tester
Type: ITester
The tester interface.
displayName
Type: String The name of the button that will be used for logging and reporting of exceptions (customer facing).
buttonPosition
Type: Progile.TRIO.BaseModel.RelativePosition The position of the button relative to the label.
imageReferenceForLabel
Type: ImageReference The image reference that will be used to locate the label on the screen.
buttonActiveimageReference
Type: ImageReference
The active image reference that will be used to locate the button on the screen.
buttonInactiveImageReference
Type: ImageReference
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]
Type: Int32
The minimum Height of the line with the button.
The buttonLineHeight needs to be set for buttonPosition Above
or Under
[filters]
Type: IImageFilter[]
The filters to find the label.
Exceptions:
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
LabelWithButton(ITester, string, RelativePosition, string, string, int, int, IImageFilter[ ])
Syntax:
Parameters:
Parameter
Description
tester
Type: ITester
The tester interface.
displayName
Type: String The name of the button that will be used for logging and reporting of exceptions (customer facing).
buttonPosition
Type: Progile.TRIO.BaseModel.RelativePosition The position of the button relative to the label.
searchTextForLabel
Type: String The search text that will be used to locate the label on the screen.
searchTextForButton
Type: String
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]
Type: Int32
The minimum Height of the line with the button.
The buttonLineHeight needs to be set for buttonPosition Above
or Under
[filters]
Type: IImageFilter[]
The filters to find the label.
Exceptions:
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
Methods
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.
Properties
Last updated