Adapter Class |
Namespace: Ranorex
The Adapter type exposes the following members.
| Name | Description | |
|---|---|---|
| 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 capabilities for this adapter.
|
| Name | Description | |
|---|---|---|
| Children |
Gets the immediate children of this adapter.
| |
| 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.
| |
| Element |
The element associated with this adapter.
| |
| Enabled |
True if the element is enabled.
| |
| FlavorName |
The name of the flavor this element belongs to.
| |
| HasFocus |
True if the element has the focus.
| |
| IsSnapshot |
Gets a value indicating whether this instance is a snapshot.
| |
| Parent |
Gets the parent of this adapter.
| |
| RequiredCapabilities |
Implemented by the derived class.
| |
| ScreenRectangle |
The bounding rectangle of the element in screen coordinates.
| |
| TimeoutFactor |
Gets or sets a value that all timeouts of find operations are multiplied with.
| |
| 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.
|
| Name | Description | |
|---|---|---|
| AsT |
Returns an adapter of the specified type for the underlying element of the current adapter.
| |
| CaptureCompressedImage |
Captures a PNG image of the element.
| |
| Click |
Clicks on the adapter with the left mouse button.
| |
| Click(MouseButtons) |
Clicks on the adapter with the specified mouse buttons.
| |
| Click(Duration) |
Clicks on the adapter with the left mouse button.
| |
| Click(Location) |
Clicks on the adapter at the specified location.
| |
| Click(Int32, Duration) |
Clicks on the adapter with the left mouse button the specified number of times.
| |
| Click(MouseButtons, Duration) |
Clicks on the adapter with the specified mouse buttons.
| |
| Click(MouseButtons, Location) |
Clicks on the adapter with the specified mouse buttons at a specific location location.
| |
| Click(Location, Duration) |
Clicks on the adapter at a specific location.
| |
| 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.
| |
| ClickWithoutBoundsCheck(Location) |
Clicks on the adapter at the specified location, without reporting a warning if the location is outside the element.
| |
| ClickWithoutBoundsCheck(MouseButtons, Location) |
Clicks on the adapter with the specified mouse buttons at a specific location location,
without reporting a warning if the location is outside the element.
| |
| ClickWithoutBoundsCheck(Location, Duration) |
Clicks on the adapter at a specific location, without reporting a warning if the location is outside the element.
| |
| ClickWithoutBoundsCheck(MouseButtons, Location, Duration) |
Clicks on the adapter with the specified mouse buttons at a given location,
without reporting a warning if the location is outside the element.
| |
| ClickWithoutBoundsCheck(Location, Int32, Duration) |
Clicks on the adapter at a specific location, with the left mouse button, the specified number of times,
without reporting a warning if the location is outside the element.
| |
| ClickWithoutBoundsCheck(MouseButtons, Location, Int32, Duration) |
Clicks at the specified location relative to the adapter with the specified mouse
buttons the specified number of times, without reporting a warning if the location is outside the element.
| |
| Create(Type, Element) |
Constructs an adapter of a specific type for a given element.
| |
| CreateT(Element) |
Constructs an adapter of a specific type for a given element.
| |
| DoubleClick |
DoubleClicks on the adapter with the left mouse button.
| |
| DoubleClick(MouseButtons) |
DoubleClicks on the adapter with the specified mouse buttons.
| |
| DoubleClick(Duration) |
DoubleClicks on the adapter with the left mouse button.
| |
| DoubleClick(Location) |
DoubleClicks on the adapter with the left mouse button at a specific location location.
| |
| DoubleClick(MouseButtons, Duration) |
DoubleClicks on the adapter with the specified mouse buttons.
| |
| 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.
| |
| DoubleClickWithoutBoundsCheck(Location) |
DoubleClicks on the adapter with the left mouse button at a specific location location,
without reporting a warning if the location is outside the element.
| |
| DoubleClickWithoutBoundsCheck(MouseButtons, Location) |
DoubleClicks on the adapter with the specified mouse buttons at a specific location location,
without reporting a warning if the location is outside the element.
| |
| DoubleClickWithoutBoundsCheck(Location, Duration) |
DoubleClicks on the adapter at a specific location, without reporting a warning if the location is outside the element.
| |
| DoubleClickWithoutBoundsCheck(MouseButtons, Location, Duration) |
DoubleClicks on the adapter with the specified mouse buttons at a given location,
without reporting a warning if the location is outside the element.
| |
| DoubleTap |
Performs a double tap action on the adapter.
| |
| DoubleTap(Location) |
Performs a double tap action on the adapter with the specified location.
| |
| DoubleTap(Double, Double) |
Performs a double tap action on the adapter with the specified location.
| |
| DoubleTap(Int32, Int32) |
Performs a double tap action on the adapter with the specified location.
| |
| DoubleTapWithoutBoundsCheck(Location) |
Performs a double tap action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| DoubleTapWithoutBoundsCheck(Double, Double) |
Performs a double tap action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| DoubleTapWithoutBoundsCheck(Int32, Int32) |
Performs a double tap action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| 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 | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| FilterT |
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 try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
| Find(RxPath) |
Applies a Ranorex Path to the adapter, returning all elements which match the path.
| |
| Find(RxPath, Duration) |
Applies a Ranorex Path to the adapter, returning all elements which match the path.
| |
| FindT(RxPath) |
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).
| |
| FindT(RxPath, Duration) |
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).
| |
| FindChildT |
Finds an immediate child element of the given capability adapter type.
| |
| FindChildT(String) | Obsolete.
Finds an immediate child element of the given capability adapter type with a specific label.
| |
| FindChildrenT |
Finds immediate child elements of the given capability adapter type.
| |
| FindChildrenT(String) | Obsolete.
Finds immediate child elements of the given capability adapter type with a specific label.
| |
| FindDescendantT |
Finds a descendant of the given capability adapter type.
| |
| FindDescendantT(String) | Obsolete.
Finds a descendant of the given capability adapter type with a specific label.
| |
| FindDescendantsT |
Finds all descendants of the given capability adapter type.
| |
| FindDescendantsT(String) | Obsolete.
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.
| |
| FindSingleT(RxPath) |
Applies a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
| |
| FindSingleT(RxPath, Duration) |
Applies a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
| |
| Focus |
Tries to set the focus on the element.
| |
| GetAttributeValueT |
Gets an attribute value using a generic return type.
| |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
| GetPath |
Builds an absolute RxPath to the element, using the 'Default' path-build mode.
| |
| GetPath(PathBuildMode) |
Builds an absolute RxPath to the element.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| ListToSingleOrNullT |
Returns the first item in the list or null if the
list is empty.
| |
| LongTouch |
Performs a long touch action on the adapter.
| |
| LongTouch(Duration) |
Performs a long touch action on the adapter.
| |
| LongTouch(Location) |
Performs a long touch action on the adapter with the specified location.
| |
| LongTouch(Double, Double) |
Performs a long touch action on the adapter with the specified location.
| |
| LongTouch(Int32, Int32) |
Performs a long touch action on the adapter with the specified location.
| |
| LongTouch(Location, Duration) |
Performs a long touch action on the adapter with the specified location.
| |
| LongTouch(Double, Double, Duration) |
Performs a long touch action on the adapter with the specified location.
| |
| LongTouch(Int32, Int32, Duration) |
Performs a long touch action on the adapter with the specified location.
| |
| LongTouchWithoutBoundsCheck(Location) |
Performs a long touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| LongTouchWithoutBoundsCheck(Double, Double) |
Performs a long touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| LongTouchWithoutBoundsCheck(Int32, Int32) |
Performs a long touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| LongTouchWithoutBoundsCheck(Location, Duration) |
Performs a long touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| LongTouchWithoutBoundsCheck(Double, Double, Duration) |
Performs a long touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| LongTouchWithoutBoundsCheck(Int32, Int32, Duration) |
Performs a long touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| MouseDown |
Holds down on the adapter with the specified mouse buttons.
| |
| MouseUp |
Releases on the adapter with the specified mouse buttons.
| |
| 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.
| |
| MoveToWithoutBoundsCheck(Location) |
Moves the mouse to the specified location in the adapter, without reporting a warning if the location is outside the element.
| |
| MoveToWithoutBoundsCheck(Location, Duration) |
Moves the mouse to the specified location in the adapter, without reporting a warning if the location is outside the element.
| |
| PressKeys(String) |
Tries to set focus to the adapter and then presses the keys specified by sequence.
| |
| PressKeys(String, Duration) |
Tries to set focus to the adapter and then presses the keys specified by sequence.
| |
| Swipe(GestureDirection, Distance) |
Performs a 'Swipe' operation that starts on the center point of the element with a specific direction.
| |
| Swipe(Location, GestureDirection, Distance, Duration, Int32) |
Performs a 'Swipe' operations that starts at the point of the element specified by location.
| |
| SwipeWithoutBoundsCheck |
Performs a 'Swipe' operations that starts at the point of the element specified by location,
without reporting a warning if the location is outside the element.
| |
| ToString |
Returns a String that represents the current Object.
(Overrides ObjectToString.) | |
| Touch |
Performs a touch action on the adapter.
| |
| Touch(Duration) |
Performs a touch action on the adapter.
| |
| Touch(Location) |
Performs a touch action on the adapter.
| |
| Touch(Double, Double) |
Performs a touch action on the adapter with the specified location.
| |
| Touch(Int32, Int32) |
Performs a touch action on the adapter with the specified location.
| |
| Touch(Location, Duration) |
Performs a touch action on the adapter.
| |
| Touch(Double, Double, Duration) |
Performs a touch action on the adapter with the specified location.
| |
| Touch(Int32, Location, Duration) |
Performs a touch action on the adapter.
| |
| Touch(Int32, Int32, Duration) |
Performs a touch action on the adapter with the specified location.
| |
| TouchEnd(Location) |
Finishes a multi touch operation on the adapter. | |
| TouchEnd(Double, Double) |
Finishes a multi touch operation on the adapter. | |
| TouchEnd(Int32, Location) |
Finishes a multi touch operation on the adapter. | |
| TouchEnd(Int32, Int32) |
Finishes a multi touch operation on the adapter. | |
| TouchEnd(Location, Duration) |
Finishes a multi touch operation on the adapter. | |
| TouchEnd(Int32, Location, Duration) |
Finishes a multi touch operation on the adapter. | |
| TouchEndWithoutBoundsCheck(Location) |
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchEndWithoutBoundsCheck(Double, Double) |
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchEndWithoutBoundsCheck(Int32, Location) |
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchEndWithoutBoundsCheck(Int32, Int32) |
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchEndWithoutBoundsCheck(Location, Duration) |
Finishes a multi touch operation on the adapter,
without reporting a warning if the location is outside the element. | |
| TouchEndWithoutBoundsCheck(Int32, Location, Duration) |
Finishes a multi touch operation on the adapter,
without reporting a warning if the location is outside the element. | |
| TouchMove(Location) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Double, Double) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Int32, Location) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Int32, Int32) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Location, Duration) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Double, Double, Duration) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Int32, Location, Duration) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMove(Int32, Int32, Duration) |
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Location) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Double, Double) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Int32, Location) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Int32, Int32) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Location, Duration) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Double, Double, Duration) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Int32, Location, Duration) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchMoveWithoutBoundsCheck(Int32, Int32, Duration) |
Performs a touch move action on the adapter, without reporting a warning if the location is outside the element.
This adds a move to the specified location with finger/mouse pressed.
| |
| TouchStart(Location) |
Performs a touch start action on the adapter.
| |
| TouchStart(Double, Double) |
Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures.
E.g. a swipe from left to right could be composed in the following way:
adapter.TouchStart(Location.Left); adapter.TouchEnd(Location.Right);
| |
| TouchStart(Int32, Location) |
Performs a touch start action on the adapter.
| |
| TouchStart(Int32, Int32) |
Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures.
E.g. a swipe from left to right could be composed in the following way:
adapter.TouchStart(Location.Left); adapter.TouchEnd(Location.Right);
| |
| TouchStartWithoutBoundsCheck(Location) |
Performs a touch start action on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchStartWithoutBoundsCheck(Double, Double) |
Begins a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Multi touch operations can be used to compose more complex touch gestures.
E.g. a swipe from left to right could be composed in the following way:
adapter.TouchStart(Location.Left); adapter.TouchEnd(Location.Right);
| |
| TouchStartWithoutBoundsCheck(Int32, Location) |
Performs a touch start action on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchStartWithoutBoundsCheck(Int32, Int32) |
Begins a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Multi touch operations can be used to compose more complex touch gestures.
E.g. a swipe from left to right could be composed in the following way:
adapter.TouchStart(Location.Left); adapter.TouchEnd(Location.Right);
| |
| TouchWithoutBoundsCheck(Location) |
Performs a touch action on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchWithoutBoundsCheck(Double, Double) |
Performs a touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| TouchWithoutBoundsCheck(Int32, Int32) |
Performs a touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| TouchWithoutBoundsCheck(Location, Duration) |
Performs a touch action on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchWithoutBoundsCheck(Double, Double, Duration) |
Performs a touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| TouchWithoutBoundsCheck(Int32, Location, Duration) |
Performs a touch action on the adapter, without reporting a warning if the location is outside the element.
| |
| TouchWithoutBoundsCheck(Int32, Int32, Duration) |
Performs a touch action on the adapter with the specified location,
without reporting a warning if the location is outside the element.
| |
| TryCreate(Type, Element, Adapter) |
Tries to construct an adapter of a specific type for a given element.
| |
| TryCreateT(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.
| |
| TryFindSingleT(RxPath, T) |
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
| |
| TryFindSingleT(RxPath, Duration, T) |
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
|
| Name | Description | |
|---|---|---|
| (Adapter to Element) |
Converts the adapter to an Element by returning the underlying element.
|