RanorexNetRanorex Documentation
Adapter Class
NamespacesRanorexAdapter
The base class for all role and capability adapters.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class Adapter
Public MustInherit Class Adapter
public ref class Adapter abstract
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
Adapter()()()
Creates a new instance that has no Element assigned to it. This constructor is used internally by the Ranorex Core Framework for performance issues!

Adapter(Element)
Checks if the element provides the required capabilites for this adapter.

As<(Of <(T>)>)()()()
Returns an adapter of the specified type for the underlying element of the current adapter.

CaptureCompressedImage()()()
Captures a PNG image of the control.

Children
Gets the immediate children of this adapter.

Click()()()
Clicks on the adapter with the left mouse button.

Click(MouseButtons)
Clicks on the adapter with the specified mouse buttons.

Click(Location)
Clicks on the adapter at the specified location.

Click(Duration)
Clicks on the adapter with the left mouse button.

Click(MouseButtons, Location)
Clicks on the adapter with the specified mouse buttons at a specific location location.

Click(MouseButtons, Duration)
Clicks on the adapter with the specified mouse buttons.

Click(Location, Duration)
Clicks on the adapter at a specific location.

Click(Int32, Duration)
Clicks on the adapter with the left mouse button the specified number of times.

Click(MouseButtons, Location, Duration)
Clicks on the adapter with the specified mouse buttons at a given location.

Click(MouseButtons, Int32, Duration)
Clicks on the adapter with the specified mouse buttons the specified number of times.

Click(Location, Int32, Duration)
Clicks on the adapter at a specific location, with the left mouse button, the specified number of times.

Click(MouseButtons, Location, Int32, Duration)
Clicks at the specified location relative to the adapter with the specified mouse buttons the specified number of times.

Create(Type, Element)
Constructs an adapter of a specific type for a given element.

Create<(Of <(T>)>)(Element)
Constructs an adapter of a specific type for a given element.

DefaultSearchTimeout
The timeout used when adapters are searched by assigning a path to an adapter variable (implicit cast operator).

DefaultUseEnsureVisible
Gets or sets the default value for the UseEnsureVisible property.

DoubleClick()()()
DoubleClicks on the adapter with the left mouse button.

DoubleClick(MouseButtons)
DoubleClicks on the adapter with the specified mouse buttons.

DoubleClick(MouseButtons, Duration)
DoubleClicks on the adapter with the specified mouse buttons.

DoubleClick(Location)
DoubleClicks on the adapter with the left mouse button at a specific location location.

DoubleClick(Duration)
DoubleClicks on the adapter with the left mouse button.

DoubleClick(MouseButtons, Location)
DoubleClicks on the adapter with the specified mouse buttons at a specific location location.

DoubleClick(Location, Duration)
DoubleClicks on the adapter at a specific location.

DoubleClick(MouseButtons, Location, Duration)
DoubleClicks on the adapter with the specified mouse buttons at a given location.

Element
The element associated with this adapter.

Enabled
True if the element is enabled.

EnsureVisible()()()
Ensures that the element is visible to the user. This is usually accomplished by bringing the element or one of its ancestors to foreground.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Filter<(Of <(T>)>)(IList<(Of <(Element>)>))
Filters the given element list by the specified adapter type. The returned adapter list correspond to the elements that could be converted to the specified adapter type.

Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Find<(Of <(T>)>)(RxPath)
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).

Find(RxPath)
Applies a Ranorex Path to the adapter, returning all elements which match the path.

Find<(Of <(T>)>)(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).

Find(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning all elements which match the path.

FindChild<(Of <(T>)>)()()()
Finds an immediate child element of the given capability adapter type.

FindChild<(Of <(T>)>)(String)
Finds an immediate child element of the given capability adapter type with a specific label.

FindChildren<(Of <(T>)>)()()()
Finds immediate child elements of the given capability adapter type.

FindChildren<(Of <(T>)>)(String)
Finds immediate child elements of the given capability adapter type with a specific label.

FindDescendant<(Of <(T>)>)()()()
Finds a descendant of the given capability adapter type.

FindDescendant<(Of <(T>)>)(String)
Finds a descendant of the given capability adapter type with a specific label.

FindDescendants<(Of <(T>)>)()()()
Finds all descendants of the given capability adapter type.

FindDescendants<(Of <(T>)>)(String)
Finds all descendants of the given capability adapter type with a specific label.

FindSingle(RxPath)
Applies a Ranorex Path to the adapter, returning an Element.

FindSingle(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning an Element.

FindSingle<(Of <(T>)>)(RxPath)
Applies a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).

FindSingle<(Of <(T>)>)(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).

FlavorName
The name of the flavor this element belongs to.

Focus()()()
Tries to set the focus on the element.

GetAttributeValue<(Of <(T>)>)(String)
Gets an attribute value, requesting a specific type.

GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetPath(PathBuildMode)
Builds an absolute RxPath to the element.

GetPath()()()
Builds an absolute RxPath to the element, using the 'Reduce' path-build mode.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HasFocus
True if the element has the focus.

Implicit(Adapter)
Converts the adapter to an Element by returning the underlying element.

IsSnapshot
Gets a value indicating whether this instance is a snapshot.

ListToSingleOrNull<(Of <(T>)>)(IList<(Of <(T>)>))
Returns the first item in the list or null if the list is empty.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MoveTo()()()
Moves the mouse to the adapter.

MoveTo(Duration)
Moves the mouse to the adapter.

MoveTo(Location)
Moves the mouse to the specified location in the adapter.

MoveTo(Location, Duration)
Moves the mouse to the specified location in the adapter.

RequiredCapabilities
Implemented by the derived class.

ScreenRectangle
The bounding rectangle of the element in screen coordinates.

ToString()()()
Returns a String that represents the current Object.
(Overrides Object.ToString()()().)
TryCreate(Type, Element, Adapter%)
Tries to construct an adapter of a specific type for a given element.

TryCreate<(Of <(T>)>)(Element, T%)
Tries to construct an adapter of a specific type for a given element.

TryFindSingle(RxPath, Element%)
Tries to apply a Ranorex Path to the adapter, returning an Element.

TryFindSingle(RxPath, Duration, Element%)
Tries to apply a Ranorex Path to the adapter, returning an Element.

TryFindSingle<(Of <(T>)>)(RxPath, T%)
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).

TryFindSingle<(Of <(T>)>)(RxPath, Duration, T%)
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).

UseEnsureVisible
Gets or sets a value indicating whether EnsureVisible()()() should be called before Click()()(), DoubleClick()()(), or MoveTo()()() actions on this adapter instance.

Valid
Returns true if the element is believed to be valid.

Visible
True if the element is visible.

Inheritance Hierarchy

Assembly: Ranorex.Core (Module: Ranorex.Core) Version: 2.3.2.8802 (2.3.2.8802)