ValidateContainsImage Method (Element, Bitmap, ImagingFindOptions, String, Boolean)

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

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

Syntax

public static bool ContainsImage(
	Element element,
	Bitmap image,
	ImagingFindOptions findOptions,
	string message,
	bool exceptionOnFail
)

Public Shared Function ContainsImage ( 
	element As Element,
	image As Bitmap,
	findOptions As ImagingFindOptions,
	message As String,
	exceptionOnFail As Boolean
) As Boolean

Parameters

element: Type: Ranorex.CoreElement
The element to take the screenshot from.
image: Type: System.DrawingBitmap
The image to search inside the element screenshot.
findOptions: Type: RanorexImagingFindOptions
A ImagingFindOptions instance that defines the options for the search.
message: Type: SystemString
The message to log. "{0}" is replaced by the string representation of the element.
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 is contained in the screenshot of the element; otherwise false.

Exceptions

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

Reference

Validate Class

ContainsImage Overload

Ranorex Namespace

ValidateAddLanguageSpecificTextSet("LSTE8E9DE6E_0?cpp=::|nu=.");ContainsImage Method (Element, Bitmap, ImagingAddLanguageSpecificTextSet("LSTE8E9DE6E_1?cpp=::|nu=.");FindOptions, String, Boolean)

Parameters

Return Value

Reference

ValidateContainsImage Method (Element, Bitmap, ImagingFindOptions, String, Boolean)