Class ToolTip
- Namespace
- Ranorex
- Assembly
- Ranorex.Core.dll
Represents tooltip popup.
public class ToolTip : Adapter, IAdapter
- Inheritance
-
ToolTip
- Implements
- Inherited Members
Constructors
ToolTip()
Creates a new ToolTip adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!
protected ToolTip()
ToolTip(Element)
Creates a new ToolTip adapter instance.
public ToolTip(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
Current
Gets the currently active tooltip.
public static ToolTip Current { get; }
Property Value
- ToolTip
The currently visible tooltip.
Exceptions
- ElementNotFoundException
If the element is not found.
RequiredCapabilities
Capabilities required by the adapter implementation.
protected override string[] RequiredCapabilities { get; }
Property Value
- string[]
Text
The text of the tooltip.
public virtual string Text { get; }
Property Value
Methods
FromElement(Element)
Converts an Element to an instance of this class.
public static ToolTip FromElement(Element element)
Parameters
elementElementThe element to convert.
Returns
- ToolTip
The ToolTip.
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 ToolTip FromPath(string path)
Parameters
pathstringThe search path.
Returns
- ToolTip
The ToolTip.
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 ToolTip(Element)
Implicitly converts an Element to an instance of this class.
public static implicit operator ToolTip(Element element)
Parameters
elementElementThe element to convert.
Returns
- ToolTip
The ToolTip.
Exceptions
- ArgumentNullException
If
elementisnull.- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.
implicit operator ToolTip(string)
Implicitly converts a string to an instance of this class by searching the root.
public static implicit operator ToolTip(string path)
Parameters
pathstringThe search path.
Returns
- ToolTip
The ToolTip.
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.