Table of Contents

Class Checkable

Namespace
Ranorex
Assembly
Ranorex.Core.dll

Represents an element that allows the user to select a true or false condition.

public class Checkable : Adapter, IAdapter
Inheritance
Checkable
Implements
Inherited Members

Constructors

Checkable()

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

protected Checkable()

Checkable(Element)

Creates a new Checkable adapter instance.

public Checkable(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

Checked

True if the element is checked.

public virtual bool Checked { get; set; }

Property Value

bool

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static Checkable FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

Checkable

The Checkable.

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 Checkable FromPath(string path)

Parameters

path string

The search path.

Returns

Checkable

The Checkable.

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.

Operators

implicit operator Checkable(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator Checkable(Element element)

Parameters

element Element

The element to convert.

Returns

Checkable

The Checkable.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

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

implicit operator Checkable(string)

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

public static implicit operator Checkable(string path)

Parameters

path string

The search path.

Returns

Checkable

The Checkable.

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.