ValidateCompareImage Method (RepoItemInfo, Bitmap, ImagingFindOptions, String, Boolean)

Validates if the screenshot of the specified repository item matches the given image.

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

Syntax

public static bool CompareImage(
	RepoItemInfo itemInfo,
	Bitmap image,
	ImagingFindOptions findOptions,
	string message,
	bool exceptionOnFail
)

Public Shared Function CompareImage ( 
	itemInfo As RepoItemInfo,
	image As Bitmap,
	findOptions As ImagingFindOptions,
	message As String,
	exceptionOnFail As Boolean
) As Boolean

Parameters

itemInfo: Type: Ranorex.Core.RepositoryRepoItemInfo
The RepoItemInfo object for the repository item.
image: Type: System.DrawingBitmap
The image which is compared to the item 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 name of the itemInfo object.
exceptionOnFail: Type: SystemBoolean
A value specifying if an exception should be thrown if the validation fails.

Return Value

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

Exceptions

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

Reference

Validate Class

CompareImage Overload

Ranorex Namespace

ValidateAddLanguageSpecificTextSet("LST3672BBCD_0?cpp=::|nu=.");CompareImage Method (RepoItemInfo, Bitmap, ImagingAddLanguageSpecificTextSet("LST3672BBCD_1?cpp=::|nu=.");FindOptions, String, Boolean)

Parameters

Return Value

Reference

ValidateCompareImage Method (RepoItemInfo, Bitmap, ImagingFindOptions, String, Boolean)