Class NativeItem
- Namespace
- Ranorex
- Assembly
- Ranorex.Plugin.Win32.dll
This element represents a native item (a logical part of a win32 control).
public class NativeItem : Adapter, IAdapter
- Inheritance
-
NativeItem
- Implements
- Inherited Members
Constructors
NativeItem()
Creates a new NativeItem adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!
protected NativeItem()
NativeItem(Element)
Creates a new NativeItem adapter instance.
public NativeItem(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
CommandId
The item command id.
public virtual int CommandId { get; }
Property Value
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 NativeItem FromElement(Element element)
Parameters
elementElementThe element to convert.
Returns
- NativeItem
The NativeItem.
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 NativeItem FromPath(string path)
Parameters
pathstringThe search path.
Returns
- NativeItem
The NativeItem.
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.
Operators
implicit operator NativeItem(Element)
Implicitly converts an Element to an instance of this class.
public static implicit operator NativeItem(Element element)
Parameters
elementElementThe element to convert.
Returns
- NativeItem
The NativeItem.
Exceptions
- ArgumentNullException
If
elementisnull.- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.
implicit operator NativeItem(string)
Implicitly converts a string to an instance of this class by searching the root.
public static implicit operator NativeItem(string path)
Parameters
pathstringThe search path.
Returns
- NativeItem
The NativeItem.
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.