Table of Contents

Class RawImage

Namespace
Ranorex
Assembly
Ranorex.Plugin.RawText.dll

Raw image data drawn by the GDI API.

public class RawImage : Adapter, IAdapter
Inheritance
RawImage
Implements
Inherited Members

Constructors

RawImage()

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

protected RawImage()

RawImage(Element)

Creates a new RawImage adapter instance.

public RawImage(Element element)

Parameters

element Element

The element to create the adapter for.

Exceptions

NullReferenceException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Properties

Id

The generated image id.

public virtual string Id { get; }

Property Value

string

Origin

The origin of the captured image.

public virtual string Origin { get; }

Property Value

string

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 RawImage FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

RawImage

The RawImage.

Exceptions

ArgumentNullException

If element is null.

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 RawImage FromPath(string path)

Parameters

path string

The search path.

Returns

RawImage

The RawImage.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Operators

implicit operator RawImage(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator RawImage(Element element)

Parameters

element Element

The element to convert.

Returns

RawImage

The RawImage.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

implicit operator RawImage(string)

Implicitly converts a string to an instance of this class by searching the root.

public static implicit operator RawImage(string path)

Parameters

path string

The search path.

Returns

RawImage

The RawImage.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.