RanorexRanorex Documentation
UIAutomation Class
NamespacesRanorexUIAutomation
Capability of an UI AutomationElement.
Declaration Syntax
C#Visual BasicVisual C++
public class UIAutomation : Adapter
Public Class UIAutomation _
	Inherits Adapter
public ref class UIAutomation : public Adapter
Members
All MembersConstructorsMethodsProperties



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

UIAutomation(Element)
Creates a new UIAutomation adapter instance.

AcceleratorKey
The accelerator key combination of the element.

AccessKey
The access key character of the element.

As<(Of <(T>)>)()()()
Returns an adapter of the specified type for the underlying element of the current adapter.
(Inherited from Adapter.)
AutomationElement
The internal AutomationElement used to communicate with this UI element.

AutomationId
The UI automation identifier of the element.

CaptureCompressedImage()()()
Captures a PNG image of the element.
(Inherited from Adapter.)
Children
Gets the immediate children of this adapter.
(Inherited from Adapter.)
ClassName
The class name of the element.

Click()()()
Clicks on the adapter with the left mouse button.
(Inherited from Adapter.)
Click(MouseButtons)
Clicks on the adapter with the specified mouse buttons.
(Inherited from Adapter.)
Click(Location)
Clicks on the adapter at the specified location.
(Inherited from Adapter.)
Click(Duration)
Clicks on the adapter with the left mouse button.
(Inherited from Adapter.)
Click(MouseButtons, Location)
Clicks on the adapter with the specified mouse buttons at a specific location location.
(Inherited from Adapter.)
Click(MouseButtons, Duration)
Clicks on the adapter with the specified mouse buttons.
(Inherited from Adapter.)
Click(Location, Duration)
Clicks on the adapter at a specific location.
(Inherited from Adapter.)
Click(Int32, Duration)
Clicks on the adapter with the left mouse button the specified number of times.
(Inherited from Adapter.)
Click(MouseButtons, Location, Duration)
Clicks on the adapter with the specified mouse buttons at a given location.
(Inherited from Adapter.)
Click(MouseButtons, Int32, Duration)
Clicks on the adapter with the specified mouse buttons the specified number of times.
(Inherited from Adapter.)
Click(Location, Int32, Duration)
Clicks on the adapter at a specific location, with the left mouse button, the specified number of times.
(Inherited from Adapter.)
Click(MouseButtons, Location, Int32, Duration)
Clicks at the specified location relative to the adapter with the specified mouse buttons the specified number of times.
(Inherited from Adapter.)
ControlType
The control type of the element.

DoubleClick()()()
DoubleClicks on the adapter with the left mouse button.
(Inherited from Adapter.)
DoubleClick(MouseButtons)
DoubleClicks on the adapter with the specified mouse buttons.
(Inherited from Adapter.)
DoubleClick(MouseButtons, Duration)
DoubleClicks on the adapter with the specified mouse buttons.
(Inherited from Adapter.)
DoubleClick(Location)
DoubleClicks on the adapter with the left mouse button at a specific location location.
(Inherited from Adapter.)
DoubleClick(Duration)
DoubleClicks on the adapter with the left mouse button.
(Inherited from Adapter.)
DoubleClick(MouseButtons, Location)
DoubleClicks on the adapter with the specified mouse buttons at a specific location location.
(Inherited from Adapter.)
DoubleClick(Location, Duration)
DoubleClicks on the adapter at a specific location.
(Inherited from Adapter.)
DoubleClick(MouseButtons, Location, Duration)
DoubleClicks on the adapter with the specified mouse buttons at a given location.
(Inherited from Adapter.)
DoubleTap()()()
Performs a double tap action on the adapter.
(Inherited from Adapter.)
DoubleTap(Int32, Int32)
Performs a double tap action on the adapter with the specified location.
(Inherited from Adapter.)
DoubleTap(Double, Double)
Performs a double tap action on the adapter with the specified location.
(Inherited from Adapter.)
DoubleTap(Location)
Performs a double tap action on the adapter with the specified location.
(Inherited from Adapter.)
Element
The element associated with this adapter.
(Inherited from Adapter.)
Enabled
True if the element is enabled.
(Inherited from Adapter.)
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.
(Inherited from Adapter.)
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.
(Inherited from Adapter.)
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<(Of <(T>)>)(RxPath)
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).
(Inherited from Adapter.)
Find<(Of <(T>)>)(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning instances of a specific adapter type (e.g. Role or Capability).
(Inherited from Adapter.)
FindChild<(Of <(T>)>)()()()
Finds an immediate child element of the given capability adapter type.
(Inherited from Adapter.)
FindChild<(Of <(T>)>)(String)
Finds an immediate child element of the given capability adapter type with a specific label.
(Inherited from Adapter.)
FindChildren<(Of <(T>)>)()()()
Finds immediate child elements of the given capability adapter type.
(Inherited from Adapter.)
FindChildren<(Of <(T>)>)(String)
Finds immediate child elements of the given capability adapter type with a specific label.
(Inherited from Adapter.)
FindDescendant<(Of <(T>)>)()()()
Finds a descendant of the given capability adapter type.
(Inherited from Adapter.)
FindDescendant<(Of <(T>)>)(String)
Finds a descendant of the given capability adapter type with a specific label.
(Inherited from Adapter.)
FindDescendants<(Of <(T>)>)()()()
Finds all descendants of the given capability adapter type.
(Inherited from Adapter.)
FindDescendants<(Of <(T>)>)(String)
Finds all descendants of the given capability adapter type with a specific label.
(Inherited from Adapter.)
FindSingle(RxPath)
Applies a Ranorex Path to the adapter, returning an Element.
(Inherited from Adapter.)
FindSingle(RxPath, Duration)
Applies a Ranorex Path to the adapter, returning an Element.
(Inherited from Adapter.)
FlavorName
The name of the flavor this element belongs to.
(Inherited from Adapter.)
Focus()()()
Tries to set the focus on the element.
(Inherited from Adapter.)
FrameworkId
The name of the underlying UI framework.

GetAttributeValue<(Of <(T>)>)(String)
Gets an attribute value, requesting a specific type.
(Inherited from Adapter.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetPath(PathBuildMode)
Builds an absolute RxPath to the element.
(Inherited from Adapter.)
GetPath()()()
Builds an absolute RxPath to the element, using the 'Reduce' path-build mode.
(Inherited from Adapter.)
GetType()()()
Gets the type of the current instance.
(Inherited from Object.)
HasFocus
True if the element has the focus.
(Inherited from Adapter.)
HelpText
The help text associated with the element.

Implicit(String)
Implicitly converts a string to an instance of this class by searching the root.

Implicit(Element)
Implicitly converts an Element to an instance of this class.

IsContentElement
A value that specifies whether the element is a content element.

IsControlElement
A value that indicates whether the element is viewed as a control.

IsKeyboardFocusable
A value that indicates whether the element can accept keyboard focus.

IsPassword
A value that indicates whether the element contains protected content.

IsRequiredForForm
A value that indicates whether the element is required to be filled out on a form.

IsSnapshot
Gets a value indicating whether this instance is a snapshot.
(Inherited from Adapter.)
ItemStatus
A description of the status of an item within an element.

ItemType
A description of the type of an item.

LocalizedControlType
A description of the control type.

LongTouch()()()
Performs a long touch action on the adapter.
(Inherited from Adapter.)
LongTouch(Int32, Int32)
Performs a long touch action on the adapter with the specified location.
(Inherited from Adapter.)
LongTouch(Double, Double)
Performs a long touch action on the adapter with the specified location.
(Inherited from Adapter.)
LongTouch(Location)
Performs a long touch action on the adapter with the specified location.
(Inherited from Adapter.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MoveTo()()()
Moves the mouse to the adapter.
(Inherited from Adapter.)
MoveTo(Duration)
Moves the mouse to the adapter.
(Inherited from Adapter.)
MoveTo(Location)
Moves the mouse to the specified location in the adapter.
(Inherited from Adapter.)
MoveTo(Location, Duration)
Moves the mouse to the specified location in the adapter.
(Inherited from Adapter.)
Name
The name of the element.

NativeWindowHandle
The handle of the element's window.

Orientation
The orientation of the control.

PressKeys(String)
Tries to set focus to the adapter and then presses the keys specified by sequence.
(Inherited from Adapter.)
PressKeys(String, Duration)
Tries to set focus to the adapter and then presses the keys specified by sequence.
(Inherited from Adapter.)
ProcessId
The process identifier (ID) of this element.

RequiredCapabilities
Capabilities required by the adapter implementation.
(Overrides Adapter.RequiredCapabilities.)
ScreenRectangle
The bounding rectangle of the element in screen coordinates.
(Inherited from Adapter.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Adapter.)
Touch()()()
Performs a touch action on the adapter.
(Inherited from Adapter.)
Touch(Int32, Int32)
Performs a touch action on the adapter with the specified location.
(Inherited from Adapter.)
Touch(Double, Double)
Performs a touch action on the adapter with the specified location.
(Inherited from Adapter.)
Touch(Location)
Performs a touch action on the adapter.
(Inherited from Adapter.)
TouchEnd(Int32, Int32)
Finishes a multi touch operation on the adapter.
(Inherited from Adapter.)
TouchEnd(Double, Double)
Finishes a multi touch operation on the adapter.
(Inherited from Adapter.)
TouchEnd(Location)
Finishes a multi touch operation on the adapter.
(Inherited from Adapter.)
TouchEnd(Int32, Location)
Finishes a multi touch operation on the adapter.
(Inherited from Adapter.)
TouchEnd(Int32, Location, Duration)
Finishes a multi touch operation on the adapter.
(Inherited from Adapter.)
TouchEnd(Location, Duration)
Finishes a multi touch operation on the adapter.
(Inherited from Adapter.)
TouchMove(Int32, Int32)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
(Inherited from Adapter.)
TouchMove(Double, Double)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
(Inherited from Adapter.)
TouchMove(Location)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
(Inherited from Adapter.)
TouchMove(Int32, Location)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
(Inherited from Adapter.)
TouchMove(Int32, Location, Duration)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
(Inherited from Adapter.)
TouchMove(Location, Duration)
Performs a touch move action on the adapter. This adds a move to the specified location with finger/mouse pressed.
(Inherited from 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:
CopyC#
adapter.TouchStart(Location.Left);
adapter.TouchEnd(Location.Right);
Useful multitouch operations always have the form
  • 1 TouchStart
  • 0-N TouchMove
  • 1 TouchEnd
(Inherited from 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:
CopyC#
adapter.TouchStart(Location.Left);
adapter.TouchEnd(Location.Right);
Useful multitouch operations always have the form
  • 1 TouchStart
  • 0-N TouchMove
  • 1 TouchEnd
(Inherited from Adapter.)
TouchStart(Location)
Performs a touch start action on the adapter.
(Inherited from Adapter.)
TouchStart(Int32, Location)
Performs a touch start action on the adapter.
(Inherited from Adapter.)
TryFindSingle(RxPath, Element%)
Tries to apply a Ranorex Path to the adapter, returning an Element.
(Inherited from Adapter.)
TryFindSingle(RxPath, Duration, Element%)
Tries to apply a Ranorex Path to the adapter, returning an Element.
(Inherited from Adapter.)
TryFindSingle<(Of <(T>)>)(RxPath, T%)
Tries to apply a Ranorex Path to the adapter, returning a specific adapter type (e.g. Role or Capability).
(Inherited from Adapter.)
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).
(Inherited from Adapter.)
UseEnsureVisible
Gets or sets a value indicating whether EnsureVisible()()() should be called before Click()()(), DoubleClick()()(), or MoveTo()()() actions on this adapter instance.
(Inherited from Adapter.)
Valid
Returns true if the element is believed to be valid.
(Inherited from Adapter.)
Visible
True if the element is visible.
(Inherited from Adapter.)
Inheritance Hierarchy
Object
Adapter
 UIAutomation

Assembly: Ranorex.Plugin.Wpf (Module: Ranorex.Plugin.Wpf) Version: 4.0.3.22982 (4.0.3.22982)