Class ClickAndWaitForDocumentReady

Namespace

CSF.Screenplay.Selenium.Tasks

Assembly

CSF.Screenplay.Selenium.dll

Screenplay task similar to Click but which additionally waits for a page-load to complete after clicking.

public class ClickAndWaitForDocumentReady : ISingleElementPerformable, ICanReportForElement

Inheritance

object

ClickAndWaitForDocumentReady

Implements

ISingleElementPerformable

ICanReportForElement

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Use this task via ClickOn(element).AndWaitForANewPageToLoad(). The benefit of this task is that it ensures that (following a page-load navigation), the incoming page is ready before subsequent performables are executed.

Constructors

ClickAndWaitForDocumentReady(TimeSpan)

Initializes a new instance of the ClickAndWaitForDocumentReady class.

public ClickAndWaitForDocumentReady(TimeSpan waitTimeout)

Parameters

waitTimeout TimeSpan

The maximum duration to wait for the document to be ready.

Methods

GetReportFragment(Actor, Lazy<SeleniumElement>, IFormatsReportFragment)

Counterpart to GetReportFragment(Actor, IFormatsReportFragment) except that this method also offers a Selenium element.

public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)

Parameters

actor Actor

An actor for whom to write the report fragment

element Lazy<SeleniumElement>

The Selenium element for which the report is being written

formatter IFormatsReportFragment

A report-formatting service

Returns

ReportFragment

A human-readable report fragment.

Remarks

Please see the documentation for GetReportFragment(Actor, IFormatsReportFragment) for more information.

PerformAsAsync(ICanPerform, IWebDriver, Lazy<SeleniumElement>, CancellationToken)

Counterpart to PerformAsAsync(ICanPerform, CancellationToken) except that this method also offers a Selenium WebDriver and element.

public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)

Parameters

actor ICanPerform

The actor that is performing.

webDriver IWebDriver

The Selenium WebDriver provided from the actor's abilities.

element Lazy<SeleniumElement>

The single Selenium Element upon which this method should operate.

cancellationToken CancellationToken

An optional cancellation token by which to abort the performable.

Returns

ValueTask

A task which completes when the performable represented by the current instance is complete.

See Also

NeedsToWaitAfterPageLoad