Class DeselectByText

Namespace

CSF.Screenplay.Selenium.Actions

Assembly

CSF.Screenplay.Selenium.dll

A partial Screenplay Action which de-selects an option from an HTML <select> element based upon that option's displayed text.

public class DeselectByText : ISingleElementPerformable, ICanReportForElement

Inheritance

object

DeselectByText

Implements

ISingleElementPerformable

ICanReportForElement

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Examples

This example deselects the option "French Fries" from the element with class optional_extras, which is a descendent of an element with the ID confirm_purchase.

using CSF.Screenplay.Selenium.Elements;
using static CSF.Screenplay.Selenium.PerformableBuilder;

readonly ITarget optionalExtras = new CssSelector("#confirm_purchase .optional_extras", "the list of optional extras");

// Within the logic of a custom task, deriving from IPerformable
public async ValueTask PerformAsAsync(ICanPerform actor, CancellationToken cancellationToken = default)
{
    // ... other performance logic
    await actor.PerformAsync(DeselectTheOption("French Fries").From(optionalExtras), cancellationToken);
    // ... other performance logic
}

Remarks

Use this action via the builder method DeselectTheOption(string). Performing this action, as an actor which has the BrowseTheWeb ability, instructs the web browser to deselect an option from the HTML element indicated by the target.

Use of this action makes sense only for <select> elements which have the multiple attribute. Select elements which do not permit multiple-selection must have precisely one option always selected, which means that this action will not be effective.

This class is not a complete performable, as it relies upon shared logic to retrieve the SeleniumElement upon which it shall act. It has this in common with many Screenplay actions & tasks in the Selenium extension which operate upon a single element. These performables derive from ISingleElementPerformable. In order for this class to be used as a full-fledged performable, an instance of this type must be wrapped within an instance of SingleElementPerformableAdapter. The adapter class provides the shared boilerplate logic which provides access to the Selenium Element. Note that the builder method(s) which create instances of this type include the 'wrap within an adapter' logic. Normal usage of this performable, when creating it from a builder, does not need to be concerned with this factor.

Constructors

DeselectByText(string)

Initializes a new instance of the DeselectByText class with the specified text.

public DeselectByText(string text)

Parameters

text string

The human-readable text of the option to deselect.

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

DeselectTheOption(string)