Table of Contents

Class OptionTag

Namespace
Ranorex
Assembly
Ranorex.Plugin.Web.dll

The HTML 'option' tag.

public class OptionTag : WebElement, IAdapter
Inheritance
OptionTag
Implements
Inherited Members

Constructors

OptionTag()

Creates a new OptionTag adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!

protected OptionTag()

OptionTag(Element)

Creates a new OptionTag adapter instance.

public OptionTag(Element element)

Parameters

element Element

The element to create the adapter for.

Exceptions

NullReferenceException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Properties

Label

The 'label' attribute of the element.

public virtual string Label { get; set; }

Property Value

string

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

Selected

Gets or sets a value indicating whether this OptionTag is selected.

public bool Selected { get; set; }

Property Value

bool

true if selected; otherwise, false.

Title

The 'title' attribute of the element.

public virtual string Title { get; set; }

Property Value

string

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

Value

The 'value' attribute of the element.

public virtual string Value { get; set; }

Property Value

string

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static OptionTag FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

OptionTag

The OptionTag.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

FromPath(string)

Converts a string to an instance of this class by searching the root.

public static OptionTag FromPath(string path)

Parameters

path string

The search path.

Returns

OptionTag

The OptionTag.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Select()

Selects the option tag and raises a change event.

public virtual void Select()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

Operators

implicit operator OptionTag(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator OptionTag(Element element)

Parameters

element Element

The element to convert.

Returns

OptionTag

The OptionTag.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

implicit operator OptionTag(string)

Implicitly converts a string to an instance of this class by searching the root.

public static implicit operator OptionTag(string path)

Parameters

path string

The search path.

Returns

OptionTag

The OptionTag.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.