Button Methods
Clicks on the button. Verifies the click was successful with the specified verification and performs retries if necessary.
Syntax:
public void Click(
Func<bool> verification
)
Exception | Condition |
When the button could not be found on the screen. | |
When the Click could not be verified successfully after the configured amount of retries of the click. |
Clicks on the button and uses an update check in the provided filters as verification. Should only be used if no other verify method is applicable.
If after the click no update is detected in the region defined by filters, retries are performed.
Note: filters should be chosen so that hover / click effects of the button itself don't trigger the update.
Syntax:
public void ClickWithUpdateCheck(
ImgDiffTolerance tolerance,
double timeoutInSec = 0,
params IImageFilter[] filters
)
Parameter | Description |
tolerance | |
timeoutInSec | Type: Double
The time during which the screen is monitored for updates after the action, if not set OnScreenElement.DefaultWaitTime is used. |
filters |
Exception | Condition |
When the button could not be found on the screen. | |
When the Click could not be verified successfully after the configured amount of retries of the click. |
Performs a double click on the button. Wait time between the individual clicks is controlled by the optional parameter doubleClickDelay.
Syntax:
public void DoubleClick(
Func<bool> verification,
int doubleClickDelay = 50
)
Exception | Condition |
When the button could not be found on the screen. | |
When the DoubleClick could not be verified successfully after the configured amount of retries of the click. |
Moves the mouse over the button. Verifies the hover was successful with the specified verification and performs retries if necessary.
public void Hover(
Func<bool> verification
)
Exception | Condition |
When the button could not be found on the screen. | |
When the Hover could not be verified successfully after the configured amount of retries. |
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.
public bool IsActive()
True, if the active representation of the button is found; false, if the inactive representation is found.
Exception | Condition |
When the button could not be found on the screen. | |
The found representation was not named "active" or "inactive" |
Name | Description |
Waits for the active status. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds. | |
Waits for the active status. Returns false if the status is not reached after the given waitTime |
Waits for the active status. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds.
public bool WaitForActive()
Exception | Condition |
When the button could not be found on the screen. | |
The found representation was not named "active" or "inactive" |
Waits for the active status. Returns false if the status is not reached after the given waitTime.
public bool WaitForActive(
TimeSpan waitTime
)
Parameter | Description |
waitTime | Type: TimeSpan
How long to wait until the Button should be active. Default value is OnScreenElement.WaitTimeInSeconds |
True, if the active state was reached after waitTime, false otherwise.
Exception | Condition |
When the button could not be found on the screen. | |
The found representation was not named "active" or "inactive" |
Name | Description |
Waits for the inactive status. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds. | |
Waits for the inactive status. Returns false if the status is not reached after waitTime |
Waits for the inactive status. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds.
public bool WaitForInactive()
Exception | Condition |
When the button could not be found on the screen. | |
The found representation was not named "active" or "inactive" |
Waits for the inactive status. Returns false if the status is not reached after waitTime.
public bool WaitForInactive(
TimeSpan waitTime
)
Parameter | Description |
waitTime | Type: TimeSpan
How long to wait until the Button should be inactive. Default value is OnScreenElement.WaitTimeInSeconds |
True, if the inactive state was reached after waitTime, false otherwise.
Exception | Condition |
When the button could not be found on the screen. | |
The found representation was not named "active" or "inactive" |
Last modified 3mo ago