 | Imaging Class |
Provides methods to create screenshots of elements, to search for images, and
for image processing.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
RanorexImaging
SystemMarshalByRefObject
RanorexImaging
Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06
SyntaxThe Imaging type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
  | UseMultiThreading |
Gets a sets a value disabling or enabling multi-threading for Contains(Element, Bitmap) or Find(Element, Bitmap) operations.
True by default.
|
Methods| Name | Description | |
|---|---|---|
 | CaptureCompressedImage(Adapter) |
Captures a compressed image of an adapter.
|
| CaptureCompressedImage(Element) |
Captures a compressed image of an element.
|
| CaptureDesktopImage(Rectangle) |
Captures an image region from the desktop.
|
| CaptureDesktopImage(Element) |
Captures an image of element from the desktop.
|
| CaptureDesktopImagesWithSurroundingArea |
Captures an image of the of the element and its surrounding area from the desktop, creating two images, with different borders and sizes.
|
| CaptureDesktopImageWithSurroundingArea |
Captures an image of the of the element and its surrounding area from the desktop.
|
| CaptureImage(Element) |
Captures an image of an element.
|
| CaptureImage(Element, Int32, Boolean) |
Captures an image of an element.
|
| CaptureImageAuto(Element) |
Captures an image of the element even if it is hidden by other elements.
If this does not succeed, the visible portion of the element is captured using a screenshot.
|
| CaptureImageAuto(Element, Boolean) |
Captures an image of the element even if it is hidden by other elements.
If this does not succeed, the visible portion of the element is captured using a screenshot.
|
| CaptureImageHidden(IntPtr) |
Captures an image of the window even if it is hidden by other windows.
|
| CaptureImageHidden(Element) |
Captures an image of the element even if it is hidden by other elements.
|
| Compare(Bitmap, Bitmap) |
Compares imageA and imageB and returns their
similarity.
|
| Compare(Bitmap, Bitmap, ImagingFindOptions) |
Compares image and feature and returns whether
their similarity is greater than or equal to the value specified by
options.Similarity.
|
| Compare(Bitmap, Bitmap, Double) |
Compares imageA and imageB and returns whether
their similarity is greater than or equal to similarity.
|
| Compare(Element, Bitmap, ImagingFindOptions) |
Compares the specified feature with (a screenshot of) the
element and returns whether
their similarity is greater than or equal to the value specified by
options.Similarity.
|
| Contains(Bitmap, Bitmap) |
Searches for the specified feature in the image
using DefaultImagingFindOptions
and returns whether the feature is found.
|
| Contains(Element, Bitmap) |
Searches for the specified feature in (a screenshot of) the
element
using DefaultImagingFindOptions
and returns whether the feature is found.
|
| Contains(Bitmap, Bitmap, ImagingFindOptions) |
Searches for the specified feature in the image
and returns whether the feature is found.
|
| Contains(Element, Bitmap, ImagingFindOptions) |
Searches for the specified feature in (a screenshot of) the
element
and returns whether the feature is found.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Crop |
Crops the given image by the specified rectangle.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Find(Bitmap, Bitmap) |
Searches for the specified feature in the image
and returns a list of ImagingMatches
using DefaultImagingFindOptions.
|
| Find(Element, Bitmap) |
Searches for the specified feature in (a screenshot of) the
element and returns a list of ImagingMatches
using DefaultImagingFindOptions.
|
| Find(Bitmap, Bitmap, ImagingFindOptions) | |
| Find(Element, Bitmap, ImagingFindOptions) |
Searches for the specified feature in (a screenshot of) the
element and returns a list of ImagingMatches.
|
| FindSingle(Bitmap, Bitmap) | |
| FindSingle(Element, Bitmap) |
Searches for the specified feature in (a screenshot of) the
element
using DefaultImagingFindOptions.
|
| FindSingle(Bitmap, Bitmap, ImagingFindOptions) |
Searches for the specified feature in the image.
|
| FindSingle(Element, Bitmap, ImagingFindOptions) |
Searches for the specified feature in (a screenshot of) the
element.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| Load |
Loads a bitmap file.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| Resize(Bitmap, Double) |
Resizes the input image.
|
| Resize(Bitmap, Double, Double) |
Resizes the input image.
|
| Resize(Bitmap, Int32, Int32) |
Resizes the input image.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryFindSingle(Bitmap, Bitmap, ImagingMatch) | |
| TryFindSingle(Element, Bitmap, ImagingMatch) |
Tries to find the specified feature in (a screenshot of) the
element
using DefaultImagingFindOptions.
|
| TryFindSingle(Bitmap, Bitmap, ImagingFindOptions, ImagingMatch) |
Tries to find the specified feature in the image.
|
| TryFindSingle(Element, Bitmap, ImagingFindOptions, ImagingMatch) |
Tries to find the specified feature in (a screenshot of) the
element.
|
See Also