Class List

Namespace

Ranorex

Assembly

Ranorex.Core.dll

Represents a logical list such as a listbox.

public class List : Adapter, IAdapter

Inheritance

object

Adapter

List

Implements

IAdapter

Inherited Members

Adapter.Create(Type, Element)

Adapter.Create<T>(Element)

Adapter.TryCreate(Type, Element, out Adapter)

Adapter.TryCreate<T>(Element, out T)

Adapter.FindSingle(RxPath)

Adapter.FindSingle(RxPath, Duration)

Adapter.FindSingle<T>(RxPath)

Adapter.FindSingle<T>(RxPath, Duration)

Adapter.TryFindSingle(RxPath, out Element)

Adapter.TryFindSingle(RxPath, Duration, out Element)

Adapter.TryFindSingle<T>(RxPath, out T)

Adapter.TryFindSingle<T>(RxPath, Duration, out T)

Adapter.Find<T>(RxPath)

Adapter.Find(RxPath)

Adapter.Find<T>(RxPath, Duration)

Adapter.Find(RxPath, Duration)

Adapter.FindChild<T>()

Adapter.FindChildren<T>()

Adapter.FindDescendant<T>()

Adapter.FindDescendants<T>()

Adapter.Filter<T>(IList<Element>)

Adapter.ListToSingleOrNull<T>(IList<T>)

Adapter.CaptureCompressedImage()

Adapter.As<T>()

Adapter.GetPath(PathBuildMode)

Adapter.GetPath()

Adapter.ToString()

Adapter.EnsureVisible()

Adapter.Focus()

Adapter.Click()

Adapter.Click(MouseButtons)

Adapter.Click(Location)

Adapter.ClickWithoutBoundsCheck(Location)

Adapter.Click(Duration)

Adapter.Click(MouseButtons, Location)

Adapter.ClickWithoutBoundsCheck(MouseButtons, Location)

Adapter.Click(MouseButtons, Duration)

Adapter.Click(Location, Duration)

Adapter.ClickWithoutBoundsCheck(Location, Duration)

Adapter.Click(int, Duration)

Adapter.Click(MouseButtons, Location, Duration)

Adapter.ClickWithoutBoundsCheck(MouseButtons, Location, Duration)

Adapter.Click(MouseButtons, int, Duration)

Adapter.Click(Location, int, Duration)

Adapter.ClickWithoutBoundsCheck(Location, int, Duration)

Adapter.Click(MouseButtons, Location, int, Duration)

Adapter.ClickWithoutBoundsCheck(MouseButtons, Location, int, Duration)

Adapter.DoubleClick()

Adapter.DoubleClick(MouseButtons)

Adapter.DoubleClick(MouseButtons, Duration)

Adapter.DoubleClick(Location)

Adapter.DoubleClickWithoutBoundsCheck(Location)

Adapter.DoubleClick(Duration)

Adapter.DoubleClick(MouseButtons, Location)

Adapter.DoubleClickWithoutBoundsCheck(MouseButtons, Location)

Adapter.DoubleClick(Location, Duration)

Adapter.DoubleClickWithoutBoundsCheck(Location, Duration)

Adapter.DoubleClick(MouseButtons, Location, Duration)

Adapter.DoubleClickWithoutBoundsCheck(MouseButtons, Location, Duration)

Adapter.MoveTo()

Adapter.MoveTo(Duration)

Adapter.MoveToWithoutBoundsCheck(Location)

Adapter.MoveTo(Location)

Adapter.MoveTo(Location, Duration)

Adapter.MoveToWithoutBoundsCheck(Location, Duration)

Adapter.PressKeys(string)

Adapter.PressKeys(string, Duration)

Adapter.Touch()

Adapter.Touch(Duration)

Adapter.Touch(int, int)

Adapter.TouchWithoutBoundsCheck(int, int)

Adapter.Touch(int, int, Duration)

Adapter.TouchWithoutBoundsCheck(int, int, Duration)

Adapter.Touch(double, double)

Adapter.TouchWithoutBoundsCheck(double, double)

Adapter.Touch(double, double, Duration)

Adapter.TouchWithoutBoundsCheck(double, double, Duration)

Adapter.Touch(Location, Duration)

Adapter.TouchWithoutBoundsCheck(Location, Duration)

Adapter.Touch(Location)

Adapter.TouchWithoutBoundsCheck(Location)

Adapter.Touch(int, Location, Duration)

Adapter.TouchWithoutBoundsCheck(int, Location, Duration)

Adapter.LongTouch()

Adapter.LongTouch(Duration)

Adapter.LongTouch(int, int)

Adapter.LongTouchWithoutBoundsCheck(int, int)

Adapter.LongTouch(int, int, Duration)

Adapter.LongTouchWithoutBoundsCheck(int, int, Duration)

Adapter.LongTouch(double, double)

Adapter.LongTouchWithoutBoundsCheck(double, double)

Adapter.LongTouch(double, double, Duration)

Adapter.LongTouchWithoutBoundsCheck(double, double, Duration)

Adapter.LongTouch(Location)

Adapter.LongTouchWithoutBoundsCheck(Location)

Adapter.LongTouch(Location, Duration)

Adapter.LongTouchWithoutBoundsCheck(Location, Duration)

Adapter.Swipe(GestureDirection, Distance)

Adapter.Swipe(Location, GestureDirection, Distance, Duration, int)

Adapter.SwipeWithoutBoundsCheck(Location, GestureDirection, Distance, Duration, int)

Adapter.DoubleTap()

Adapter.DoubleTap(int, int)

Adapter.DoubleTapWithoutBoundsCheck(int, int)

Adapter.DoubleTap(double, double)

Adapter.DoubleTapWithoutBoundsCheck(double, double)

Adapter.DoubleTap(Location)

Adapter.DoubleTapWithoutBoundsCheck(Location)

Adapter.TouchStart(int, int)

Adapter.TouchStartWithoutBoundsCheck(int, int)

Adapter.TouchStart(double, double)

Adapter.TouchStartWithoutBoundsCheck(double, double)

Adapter.TouchStart(Location)

Adapter.TouchStartWithoutBoundsCheck(Location)

Adapter.TouchStart(int, Location)

Adapter.TouchStartWithoutBoundsCheck(int, Location)

Adapter.TouchEnd(int, int)

Adapter.TouchEndWithoutBoundsCheck(int, int)

Adapter.TouchEnd(double, double)

Adapter.TouchEndWithoutBoundsCheck(double, double)

Adapter.TouchEnd(Location)

Adapter.TouchEndWithoutBoundsCheck(Location)

Adapter.TouchEnd(int, Location)

Adapter.TouchEndWithoutBoundsCheck(int, Location)

Adapter.TouchEnd(int, Location, Duration)

Adapter.TouchEndWithoutBoundsCheck(int, Location, Duration)

Adapter.TouchEnd(Location, Duration)

Adapter.TouchEndWithoutBoundsCheck(Location, Duration)

Adapter.TouchMove(int, int)

Adapter.TouchMoveWithoutBoundsCheck(int, int)

Adapter.TouchMove(int, int, Duration)

Adapter.TouchMoveWithoutBoundsCheck(int, int, Duration)

Adapter.TouchMove(double, double)

Adapter.TouchMoveWithoutBoundsCheck(double, double)

Adapter.TouchMove(double, double, Duration)

Adapter.TouchMoveWithoutBoundsCheck(double, double, Duration)

Adapter.TouchMove(int, Location)

Adapter.TouchMoveWithoutBoundsCheck(int, Location)

Adapter.TouchMove(int, Location, Duration)

Adapter.TouchMoveWithoutBoundsCheck(int, Location, Duration)

Adapter.TouchMove(Location)

Adapter.TouchMoveWithoutBoundsCheck(Location)

Adapter.TouchMove(Location, Duration)

Adapter.TouchMoveWithoutBoundsCheck(Location, Duration)

Adapter.MouseDown(MouseButtons)

Adapter.MouseUp(MouseButtons)

Adapter.GetAttributeValue<T>(string)

Adapter.DefaultSearchTimeout

Adapter.TimeoutFactor

Adapter.Element

Adapter.DefaultUseEnsureVisible

Adapter.UseEnsureVisible

Adapter.Children

Adapter.Parent

Adapter.FlavorName

Adapter.ScreenRectangle

Adapter.Visible

Adapter.HasFocus

Adapter.Enabled

Adapter.IsSnapshot

Adapter.Valid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

List()

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

protected List()

List(Element)

Creates a new List adapter instance.

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

this[string]

Gets the ListItem with the specified item label.

public ListItem this[string itemLabel] { get; }

Parameters

itemLabel string

Property Value

ListItem

The list item.

Exceptions

ElementNotFoundException

If no item with that label is found.

Items

Gets the list items contained in the list.

public IList<ListItem> Items { get; }

Property Value

IList<ListItem>

The list items.

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

SelectedItemIndex

The index of the currently selected item.

public virtual int SelectedItemIndex { get; set; }

Property Value

int

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

SelectedItemText

The text of the currently selected item.

public virtual string SelectedItemText { get; set; }

Property Value

string

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

SelectedItems

Gets the list of selected items contained in the list.

public IList<ListItem> SelectedItems { get; }

Property Value

IList<ListItem>

The list items.

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static List FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

List

The List.

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

Parameters

path string

The search path.

Returns

List

The List.

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 List(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator List(Element element)

Parameters

element Element

The element to convert.

Returns

List

The List.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

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

implicit operator List(string)

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

public static implicit operator List(string path)

Parameters

path string

The search path.

Returns

List

The List.

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.