Class WebElement

dotnet/src/webdriver/WebElement.cs:32–745

A base class representing an HTML element on a page.

/// A base class representing an HTML element on a page.
/// </summary>
public class WebElement : IWebElement, IFindsElement, IWrapsDriver, ILocatable, ITakesScreenshot, IWebDriverObjectReference, IEquatable<IWebElement>
{
    /// <summary>
    /// The property name that represents a web element in the wire protocol.
    /// </summary>
    public const string ElementReferencePropertyName = "element-6066-11e4-a52e-4f735466cecf";

    private readonly WebDriver driver;

    /// <summary>
    /// Initializes a new instance of the <see cref="WebElement"/> class.
    /// </summary>
    /// <param name="parentDriver">The <see cref="WebDriver"/> instance that is driving this element.</param>
    /// <param name="id">The ID value provided to identify the element.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="parentDriver"/> or <paramref name="id"/> are <see langword="null"/>.</exception>
    public WebElement(WebDriver parentDriver, string id)
    {
        ArgumentNullException.ThrowIfNull(parentDriver);
        ArgumentNullException.ThrowIfNull(id);
        this.driver = parentDriver;
        this.Id = id;
    }

    /// <summary>
    /// Gets the <see cref="IWebDriver"/> driving this element.
    /// </summary>
    public IWebDriver WrappedDriver => this.driver;

    /// <summary>
    /// Gets the tag name of this element.
    /// </summary>
    /// <remarks>
    /// The <see cref="TagName"/> property returns the tag name of the
    /// element, not the value of the name attribute. For example, it will return
    /// "input" for an element specified by the HTML markup &lt;input name="foo" /&gt;.
    /// </remarks>
    /// <exception cref="StaleElementReferenceException">Thrown when the target element is no longer valid in the document DOM.</exception>
    public virtual string TagName
    {
        get
        {
            Dictionary<string, object> parameters = new Dictionary<string, object>();
            parameters.Add("id", this.Id);

            Response commandResponse = this.Execute(DriverCommand.GetElementTagName, parameters);

            commandResponse.EnsureValueIsNotNull();
            return commandResponse.Value.ToString()!;
        }
    }

    /// <summary>
    /// Gets the innerText of this element, without any leading or trailing whitespace,
    /// and with other whitespace collapsed.
    /// </summary>
    /// <exception cref="StaleElementReferenceException">Thrown when the target element is no longer valid in the document DOM.</exception>
    public virtual string Text
    {