Class RawTextBlock
- Namespace
- Ranorex
- Assembly
- Ranorex.Plugin.RawText.dll
Raw text block drawn by the GDI API.
public class RawTextBlock : Adapter, IAdapter
- Inheritance
-
RawTextBlock
- Implements
- Inherited Members
Constructors
RawTextBlock()
Creates a new RawTextBlock adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!
protected RawTextBlock()
RawTextBlock(Element)
Creates a new RawTextBlock adapter instance.
public RawTextBlock(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
RawText
The captured raw text.
public virtual string RawText { 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 RawTextBlock FromElement(Element element)
Parameters
elementElementThe element to convert.
Returns
- RawTextBlock
The RawTextBlock.
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 RawTextBlock FromPath(string path)
Parameters
pathstringThe search path.
Returns
- RawTextBlock
The RawTextBlock.
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 RawTextBlock(Element)
Implicitly converts an Element to an instance of this class.
public static implicit operator RawTextBlock(Element element)
Parameters
elementElementThe element to convert.
Returns
- RawTextBlock
The RawTextBlock.
Exceptions
- ArgumentNullException
If
elementisnull.- CapabilityNotSupportedException
If the element does not support the capabilities required by this adapter.
implicit operator RawTextBlock(string)
Implicitly converts a string to an instance of this class by searching the root.
public static implicit operator RawTextBlock(string path)
Parameters
pathstringThe search path.
Returns
- RawTextBlock
The RawTextBlock.
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.