 | ImagingFindOptions Class |
Defines options for image find methods (see Find(Element, Bitmap) and FindSingle(Element, Bitmap) methods).
Inheritance HierarchySystemObject
RanorexImagingFindOptions
RanorexImagingFindOptions
Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06
SyntaxThe ImagingFindOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ImagingFindOptions |
Creates a new instance.
|
| ImagingFindOptions(Double) |
Creates a new instance.
|
| ImagingFindOptions(Rectangle) |
Creates a new instance.
|
| ImagingFindOptions(ImagingPreprocessings) |
Creates a new instance.
|
| ImagingFindOptions(Double, ImagingPreprocessings) |
Creates a new instance.
|
| ImagingFindOptions(Double, ImagingPreprocessings, Rectangle) |
Creates a new instance.
|
| ImagingFindOptions(Double, ImagingPreprocessings, Rectangle, Boolean) |
Creates a new instance.
|
| ImagingFindOptions(Double, ImagingPreprocessings, Rectangle, Boolean, Double) |
Creates a new instance.
|
| ImagingFindOptions(Double, ImagingPreprocessings, Rectangle, Boolean, Double, Duration) |
Creates a new instance.
|
| ImagingFindOptions(Double, ImagingPreprocessings, Rectangle, Boolean, Double, Duration, IListRectangle) |
Creates a new instance.
|
Properties| Name | Description | |
|---|---|---|
 | BestMatch |
Gets or set a value specifying if the best (true) or the first (false) match
found in a call to FindSingle(Element, Bitmap) should be returned.
|
| Clipping |
Gets or sets a clipping rectangle in the image that defines the region where
the search takes place, i.e. not the whole image is searched but only this
rectangle inside it.
|
 | Default |
Gets or set the default options for image find methods.
|
| DownsizeTargetCosts |
Gets or sets a value that defines the estimated costs (time) for searching an image.
If Downsize is set as a preprocessing step, the
image and feature bitmaps are tried to be downsized so that the estimated search costs
match this value.
|
| IgnoreRectangles |
Gets or sets a list of ignoring rectangles in the image which define regions
the search ignores, i.e. the whole image is searched except the defined
region.
|
| Preprocessing |
Gets or sets the preprocessing steps that are performed to the image and
the feature bitmaps before searching.
|
| Similarity |
Gets or sets the minimum similarity that the feature needs to have with the
image to be considered a match.
|
| Timeout |
Gets or sets the timeout used to search for the specified feature.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a new ImagingFindOptions instance with the same values as this instance.
|
| Equals(Object) |
Determines whether this instance is equal to obj.
(Overrides ObjectEquals(Object).) |
| Equals(ImagingFindOptions) |
Indicates whether the current object is equal to another object of the same type.
|
| Equals(ImagingFindOptions, ImagingFindOptions) |
Returns true if the two instances are equal.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode |
Returns a static, very poor performing hash code!
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Parse |
Parses the given String and returns a new ImagingFindOptions instance.
|
| ToString |
Returns a string representation of the instance.
(Overrides ObjectToString.) |
| ToString(String) |
Returns a string representation of the instance using the specified format.
|
| ToString(String, IFormatProvider) |
Returns a string representation of the instance using the specified format.
|
| TryParse |
Tries parsing the given String to a ImagingFindOptions instance.
|
Operators| Name | Description | |
|---|---|---|
 | Equality |
Implements the operator ==.
|
| Inequality |
Implements the operator !=.
|
See Also