ValidateCompareImage Method (Element, Bitmap, ImagingFindOptions, String, ValidateOptions)

Validates if the screenshot of the specified element matches the given image.

Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06

Syntax

public static bool CompareImage(
	Element element,
	Bitmap image,
	ImagingFindOptions findOptions,
	string message,
	ValidateOptions options
)

Public Shared Function CompareImage ( 
	element As Element,
	image As Bitmap,
	findOptions As ImagingFindOptions,
	message As String,
	options As ValidateOptions
) As Boolean

Parameters

element: Type: Ranorex.CoreElement
The element to take the screenshot from.
image: Type: System.DrawingBitmap
The image which is compared to the element screenshot.
findOptions: Type: RanorexImagingFindOptions
A ImagingFindOptions instance that defines the options for the comparison.
message: Type: SystemString
The message to log. "{0}" is replaced by the string representation of the element.
options: Type: RanorexValidateOptions
Additional ValidateOptions for this validation action.

Return Value

Type: Boolean
True if the specified image matches the screenshot of the element; otherwise false.

Exceptions

Exception	Condition
ArgumentNullException	If image is null.
ValidationException	If the validation fails and options.ExceptionOnFail is true.

Reference

Validate Class

CompareImage Overload

Ranorex Namespace

ValidateAddLanguageSpecificTextSet("LST2A5D36CC_0?cpp=::|nu=.");CompareImage Method (Element, Bitmap, ImagingAddLanguageSpecificTextSet("LST2A5D36CC_1?cpp=::|nu=.");FindOptions, String, ValidateAddLanguageSpecificTextSet("LST2A5D36CC_2?cpp=::|nu=.");Options)

Parameters

Return Value

Reference

ValidateCompareImage Method (Element, Bitmap, ImagingFindOptions, String, ValidateOptions)