Links

Button Methods

Click

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
)

Parameters:

Parameter
Description
verification
Type: Func<Boolean> The verification method (e.g. Click(element.WaitForAppear); or Click(() => element.WaitForStatus(true));

Exceptions:

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.

DoubleClick

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
)

Parameters:

Parameter
Description
verification
Type: Func<Boolean> The verification method (e.g. DoubleClick(element.WaitForAppear); or DoubleClick(() => element.WaitForStatus(true));
[doubleClickDelay]
Type: Int32 The time to wait between the clicks.

Exceptions:

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.

Hover

Moves the mouse over the button. Verifies the hover was successful with the specified verification and performs retries if necessary.

Syntax:

public void Hover(
Func<bool> verification
)

Parameters:

Parameter
Description
verification
Type: Func<Boolean> The verification method (e.g. Hover(element.WaitForAppear); or Hover(() => element.WaitForStatus(true));

Exceptions:

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.

IsActive

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.

Syntax:

public bool IsActive()

Return Value:

True, if the active representation of the button is found; false, if the inactive representation is found.

Exceptions:

Exception
Condition
When the button could not be found on the screen.
The found representation was not named "active" or "inactive"

WaitForActive

Waits for the active status. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds.

Syntax:

public bool WaitForActive()

Return Value:

True, if the active state was reached after OnScreenElement.WaitTimeInSeconds, false otherwise.

Exceptions:

Exception
Condition
When the button could not be found on the screen.
The found representation was not named "active" or "inactive"

WaitForInactive

Waits for the inactive status. Returns false if the status is not reached after OnScreenElement.WaitTimeInSeconds.

Syntax:

public bool WaitForInactive()

Return Value:

True, if the inactive state was reached after OnScreenElement.WaitTimeInSeconds, false otherwise.

Exceptions:

Exception
Condition
When the button could not be found on the screen.
The found representation was not named "active" or "inactive"
Last modified 2yr ago