Click or drag to resize
Ranorex

Adapter Methods

The Adapter type exposes the following members.

Methods
  NameDescription
Public methodAsT
Returns an adapter of the specified type for the underlying element of the current adapter.
Public methodCaptureCompressedImage
Captures a PNG image of the element.
Public methodClick
Clicks on the adapter with the left mouse button.
Public methodClick(MouseButtons)
Clicks on the adapter with the specified mouse buttons.
Public methodClick(Duration)
Clicks on the adapter with the left mouse button.
Public methodClick(Location)
Clicks on the adapter at the specified location.
Public methodClick(Int32, Duration)
Clicks on the adapter with the left mouse button the specified number of times.
Public methodClick(MouseButtons, Duration)
Clicks on the adapter with the specified mouse buttons.
Public methodClick(MouseButtons, Location)
Clicks on the adapter with the specified mouse buttons at a specific location location.
Public methodClick(Location, Duration)
Clicks on the adapter at a specific location.
Public methodClick(MouseButtons, Location, Duration)
Clicks on the adapter with the specified mouse buttons at a given location.
Public methodClick(MouseButtons, Int32, Duration)
Clicks on the adapter with the specified mouse buttons the specified number of times.
Public methodClick(Location, Int32, Duration)
Clicks on the adapter at a specific location, with the left mouse button, the specified number of times.
Public methodClick(MouseButtons, Location, Int32, Duration)
Clicks at the specified location relative to the adapter with the specified mouse buttons the specified number of times.
Public methodClickWithoutBoundsCheck(Location)
Clicks on the adapter at the specified location, without reporting a warning if the location is outside the element.
Public methodClickWithoutBoundsCheck(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.
Public methodClickWithoutBoundsCheck(Location, Duration)
Clicks on the adapter at a specific location, without reporting a warning if the location is outside the element.
Public methodClickWithoutBoundsCheck(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.
Public methodClickWithoutBoundsCheck(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.
Public methodClickWithoutBoundsCheck(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.
Public methodStatic memberCreate(Type, Element)
Constructs an adapter of a specific type for a given element.
Public methodStatic memberCreateT(Element)
Constructs an adapter of a specific type for a given element.
Public methodDoubleClick
DoubleClicks on the adapter with the left mouse button.
Public methodDoubleClick(MouseButtons)
DoubleClicks on the adapter with the specified mouse buttons.
Public methodDoubleClick(Duration)
DoubleClicks on the adapter with the left mouse button.
Public methodDoubleClick(Location)
DoubleClicks on the adapter with the left mouse button at a specific location location.
Public methodDoubleClick(MouseButtons, Duration)
DoubleClicks on the adapter with the specified mouse buttons.
Public methodDoubleClick(MouseButtons, Location)
DoubleClicks on the adapter with the specified mouse buttons at a specific location location.
Public methodDoubleClick(Location, Duration)
DoubleClicks on the adapter at a specific location.
Public methodDoubleClick(MouseButtons, Location, Duration)
DoubleClicks on the adapter with the specified mouse buttons at a given location.
Public methodDoubleClickWithoutBoundsCheck(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.
Public methodDoubleClickWithoutBoundsCheck(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.
Public methodDoubleClickWithoutBoundsCheck(Location, Duration)
DoubleClicks on the adapter at a specific location, without reporting a warning if the location is outside the element.
Public methodDoubleClickWithoutBoundsCheck(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.
Public methodDoubleTap
Performs a double tap action on the adapter.
Public methodDoubleTap(Location)
Performs a double tap action on the adapter with the specified location.
Public methodDoubleTap(Double, Double)
Performs a double tap action on the adapter with the specified location.
Public methodDoubleTap(Int32, Int32)
Performs a double tap action on the adapter with the specified location.
Public methodDoubleTapWithoutBoundsCheck(Location)
Performs a double tap action on the adapter with the specified location, without reporting a warning if the location is outside the element.
Public methodDoubleTapWithoutBoundsCheck(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.
Public methodDoubleTapWithoutBoundsCheck(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.
Public methodEnsureVisible
Ensures that the element is visible to the user. This is usually accomplished by bringing the element or one of its ancestors to foreground.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFilterT
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.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFind(RxPath)
Applies a Ranorex Path to the adapter, returning all elements which match the path.
Public methodFind(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning all elements which match the path.
Public methodFindT(RxPath)
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).
Public methodFindT(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).
Public methodFindChildT
Finds an immediate child element of the given capability adapter type.
Public methodFindChildT(String) Obsolete.
Finds an immediate child element of the given capability adapter type with a specific label.
Public methodFindChildrenT
Finds immediate child elements of the given capability adapter type.
Public methodFindChildrenT(String) Obsolete.
Finds immediate child elements of the given capability adapter type with a specific label.
Public methodFindDescendantT
Finds a descendant of the given capability adapter type.
Public methodFindDescendantT(String) Obsolete.
Finds a descendant of the given capability adapter type with a specific label.
Public methodFindDescendantsT
Finds all descendants of the given capability adapter type.
Public methodFindDescendantsT(String) Obsolete.
Finds all descendants of the given capability adapter type with a specific label.
Public methodFindSingle(RxPath)
Applies a Ranorex Path to the adapter, returning an Element.
Public methodFindSingle(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning an Element.
Public methodFindSingleT(RxPath)
Applies a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
Public methodFindSingleT(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
Public methodFocus
Tries to set the focus on the element.
Public methodGetAttributeValueT
Gets an attribute value using a generic return type.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPath
Builds an absolute RxPath to the element, using the 'Default' path-build mode.
Public methodGetPath(PathBuildMode)
Builds an absolute RxPath to the element.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodStatic memberListToSingleOrNullT
Returns the first item in the list or null if the list is empty.
Public methodLongTouch
Performs a long touch action on the adapter.
Public methodLongTouch(Duration)
Performs a long touch action on the adapter.
Public methodLongTouch(Location)
Performs a long touch action on the adapter with the specified location.
Public methodLongTouch(Double, Double)
Performs a long touch action on the adapter with the specified location.
Public methodLongTouch(Int32, Int32)
Performs a long touch action on the adapter with the specified location.
Public methodLongTouch(Location, Duration)
Performs a long touch action on the adapter with the specified location.
Public methodLongTouch(Double, Double, Duration)
Performs a long touch action on the adapter with the specified location.
Public methodLongTouch(Int32, Int32, Duration)
Performs a long touch action on the adapter with the specified location.
Public methodLongTouchWithoutBoundsCheck(Location)
Performs a long touch action on the adapter with the specified location, without reporting a warning if the location is outside the element.
Public methodLongTouchWithoutBoundsCheck(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.
Public methodLongTouchWithoutBoundsCheck(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.
Public methodLongTouchWithoutBoundsCheck(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.
Public methodLongTouchWithoutBoundsCheck(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.
Public methodLongTouchWithoutBoundsCheck(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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMouseDown
Holds down on the adapter with the specified mouse buttons.
Public methodMouseUp
Releases on the adapter with the specified mouse buttons.
Public methodMoveTo
Moves the mouse to the adapter.
Public methodMoveTo(Duration)
Moves the mouse to the adapter.
Public methodMoveTo(Location)
Moves the mouse to the specified location in the adapter.
Public methodMoveTo(Location, Duration)
Moves the mouse to the specified location in the adapter.
Public methodMoveToWithoutBoundsCheck(Location)
Moves the mouse to the specified location in the adapter, without reporting a warning if the location is outside the element.
Public methodMoveToWithoutBoundsCheck(Location, Duration)
Moves the mouse to the specified location in the adapter, without reporting a warning if the location is outside the element.
Public methodPressKeys(String)
Tries to set focus to the adapter and then presses the keys specified by sequence.
Public methodPressKeys(String, Duration)
Tries to set focus to the adapter and then presses the keys specified by sequence.
Public methodSwipe(GestureDirection, Distance)
Performs a 'Swipe' operation that starts on the center point of the element with a specific direction.
Public methodSwipe(Location, GestureDirection, Distance, Duration, Int32)
Performs a 'Swipe' operations that starts at the point of the element specified by location.
Public methodSwipeWithoutBoundsCheck
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.
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Public methodTouch
Performs a touch action on the adapter.
Public methodTouch(Duration)
Performs a touch action on the adapter.
Public methodTouch(Location)
Performs a touch action on the adapter.
Public methodTouch(Double, Double)
Performs a touch action on the adapter with the specified location.
Public methodTouch(Int32, Int32)
Performs a touch action on the adapter with the specified location.
Public methodTouch(Location, Duration)
Performs a touch action on the adapter.
Public methodTouch(Double, Double, Duration)
Performs a touch action on the adapter with the specified location.
Public methodTouch(Int32, Location, Duration)
Performs a touch action on the adapter.
Public methodTouch(Int32, Int32, Duration)
Performs a touch action on the adapter with the specified location.
Public methodTouchEnd(Location)
Finishes a multi touch operation on the adapter.
Public methodTouchEnd(Double, Double)
Finishes a multi touch operation on the adapter.
Public methodTouchEnd(Int32, Location)
Finishes a multi touch operation on the adapter.
Public methodTouchEnd(Int32, Int32)
Finishes a multi touch operation on the adapter.
Public methodTouchEnd(Location, Duration)
Finishes a multi touch operation on the adapter.
Public methodTouchEnd(Int32, Location, Duration)
Finishes a multi touch operation on the adapter.
Public methodTouchEndWithoutBoundsCheck(Location)
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchEndWithoutBoundsCheck(Double, Double)
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchEndWithoutBoundsCheck(Int32, Location)
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchEndWithoutBoundsCheck(Int32, Int32)
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchEndWithoutBoundsCheck(Location, Duration)
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchEndWithoutBoundsCheck(Int32, Location, Duration)
Finishes a multi touch operation on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchMove(Location)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Double, Double)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Int32, Location)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Int32, Int32)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Location, Duration)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Double, Double, Duration)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Int32, Location, Duration)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMove(Int32, Int32, Duration)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchMoveWithoutBoundsCheck(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.
Public methodTouchStart(Location)
Performs a touch start action on the adapter.
Public methodTouchStart(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);
Useful multitouch operations always have the form
  • 1 TouchStart
  • 0-N TouchMove
  • 1 TouchEnd
Public methodTouchStart(Int32, Location)
Performs a touch start action on the adapter.
Public methodTouchStart(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);
Useful multitouch operations always have the form
  • 1 TouchStart
  • 0-N TouchMove
  • 1 TouchEnd
Public methodTouchStartWithoutBoundsCheck(Location)
Performs a touch start action on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchStartWithoutBoundsCheck(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);
Useful multitouch operations always have the form
  • 1 TouchStart
  • 0-N TouchMove
  • 1 TouchEnd
Public methodTouchStartWithoutBoundsCheck(Int32, Location)
Performs a touch start action on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchStartWithoutBoundsCheck(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);
Useful multitouch operations always have the form
  • 1 TouchStart
  • 0-N TouchMove
  • 1 TouchEnd
Public methodTouchWithoutBoundsCheck(Location)
Performs a touch action on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchWithoutBoundsCheck(Double, Double)
Performs a touch action on the adapter with the specified location, without reporting a warning if the location is outside the element.
Public methodTouchWithoutBoundsCheck(Int32, Int32)
Performs a touch action on the adapter with the specified location, without reporting a warning if the location is outside the element.
Public methodTouchWithoutBoundsCheck(Location, Duration)
Performs a touch action on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchWithoutBoundsCheck(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.
Public methodTouchWithoutBoundsCheck(Int32, Location, Duration)
Performs a touch action on the adapter, without reporting a warning if the location is outside the element.
Public methodTouchWithoutBoundsCheck(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.
Public methodStatic memberTryCreate(Type, Element, Adapter)
Tries to construct an adapter of a specific type for a given element.
Public methodStatic memberTryCreateT(Element, T)
Tries to construct an adapter of a specific type for a given element.
Public methodTryFindSingle(RxPath, Element)
Tries to apply a Ranorex Path to the adapter, returning an Element.
Public methodTryFindSingle(RxPath, Duration, Element)
Tries to apply a Ranorex Path to the adapter, returning an Element.
Public methodTryFindSingleT(RxPath, T)
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
Public methodTryFindSingleT(RxPath, Duration, T)
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
Top
See Also