Class AccessibleTreeItem
- Namespace
- Ranorex
- Assembly
- Ranorex.Plugin.Msaa.dll
Capability of an MSAA tree item.
public class AccessibleTreeItem : Adapter, IAdapter
- Inheritance
-
AccessibleTreeItem
- Implements
- Inherited Members
Constructors
AccessibleTreeItem()
Creates a new AccessibleTreeItem adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!
protected AccessibleTreeItem()
AccessibleTreeItem(Element)
Creates a new AccessibleTreeItem adapter instance.
public AccessibleTreeItem(Element element)
Parameters
elementElementThe element to create the adapter for.
Exceptions
- NullReferenceException
If
elementisnull.- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.
Properties
RequiredCapabilities
Capabilities required by the adapter implementation.
protected override string[] RequiredCapabilities { get; }
Property Value
- string[]
Methods
FromElement(Element)
Converts an Element to an instance of this class.
public static AccessibleTreeItem FromElement(Element element)
Parameters
elementElementThe element to convert.
Returns
- AccessibleTreeItem
The AccessibleTreeItem.
Exceptions
- ArgumentNullException
If
elementisnull.- 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 AccessibleTreeItem FromPath(string path)
Parameters
pathstringThe search path.
Returns
- AccessibleTreeItem
The AccessibleTreeItem.
Remarks
The DefaultSearchTimeout is used to search for the specified path.
Exceptions
- ArgumentNullException
If
pathisnull.- RxPathException
If the specified
pathis not valid.- ElementNotFoundException
If no element is found.
- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.
UpdateSubTree()
Updates the sub tree below this tree item.
[OriginalDisplayName("AccessibleTreeItemUpdateSubTree")]
public virtual void UpdateSubTree()
Exceptions
- ActionFailedException
Thrown if invoking the action failed.
Operators
implicit operator AccessibleTreeItem(Element)
Implicitly converts an Element to an instance of this class.
public static implicit operator AccessibleTreeItem(Element element)
Parameters
elementElementThe element to convert.
Returns
- AccessibleTreeItem
The AccessibleTreeItem.
Exceptions
- ArgumentNullException
If
elementisnull.- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.
implicit operator AccessibleTreeItem(string)
Implicitly converts a string to an instance of this class by searching the root.
public static implicit operator AccessibleTreeItem(string path)
Parameters
pathstringThe search path.
Returns
- AccessibleTreeItem
The AccessibleTreeItem.
Remarks
The DefaultSearchTimeout is used to search for the specified path.
Exceptions
- ArgumentNullException
If
pathisnull.- RxPathException
If the specified
pathis not valid.- ElementNotFoundException
If no element is found.
- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.