Validate Class

Provides a number of different validation methods.

Inheritance Hierarchy

SystemObject
RanorexValidate

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

Syntax

Copy

public static class Validate

Public NotInheritable Class Validate

The Validate type exposes the following members.

Properties

	Name	Description
	EnableReport	Gets or sets a value indicating whether validations should produce report messages or not.

Top

Methods

	Name	Description
	AreEqual(Object, Object)	Validates if the actual value of an object equals an expected value.
	AreEqual(String, Regex)	Validates if the given regular expression matches the given string.
	AreEqual(Object, Object, String)	Validates if the actual value of an object equals an expected value.
	AreEqual(String, Regex, String)	Validates if the given regular expression matches the given string.
	AreEqual(Object, Object, String, ValidateOptions)	Validates if the actual value of an object equals an expected value.
	AreEqual(Object, Object, String, Boolean)	Validates if the actual value of an object equals an expected value.
	AreEqual(String, Regex, String, ValidateOptions)	Validates if the given regular expression matches the given string.
	AreEqual(String, Regex, String, Boolean)	Validates if the given regular expression matches the given string.
	Attribute(Element, String, Object)	Validates if the attribute of the specified element matches a specific value.
	Attribute(Element, String, Regex)	Validates if the attribute of the specified element matches a specific regular expression.
	Attribute(RepoItemInfo, String, Object)	Validates if the attribute of the element for the specified repository item matches a specific value.
	Attribute(RepoItemInfo, String, Regex)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	Attribute(Element, String, Object, String)	Validates if the attribute of the specified element matches a specific value.
	Attribute(Element, String, Regex, String)	Validates if the attribute of the specified element matches a specific regular expression.
	Attribute(RepoItemInfo, String, Object, String)	Validates if the attribute of the element for the specified repository item matches a specific value.
	Attribute(RepoItemInfo, String, Regex, String)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	Attribute(Element, String, Object, String, ValidateOptions)	Validates if the attribute of the specified element matches a specific value.
	Attribute(Element, String, Object, String, Boolean)	Validates if the attribute of the specified element matches a specific value.
	Attribute(Element, String, Regex, String, ValidateOptions)	Validates if the attribute of the specified element matches a specific regular expression.
	Attribute(Element, String, Regex, String, Boolean)	Validates if the attribute of the specified element matches a specific regular expression.
	Attribute(RepoItemInfo, String, Object, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item matches a specific value.
	Attribute(RepoItemInfo, String, Object, String, Boolean)	Validates if the attribute of the element for the specified repository item matches a specific value.
	Attribute(RepoItemInfo, String, Regex, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	Attribute(RepoItemInfo, String, Regex, String, Boolean)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	AttributeContains(IElement, String, String)	Validates if the attribute of the specified element contains a specific value.
	AttributeContains(RepoItemInfo, String, String)	Validates if the attribute of the element for the specified repository item contains a specific value.
	AttributeContains(IElement, String, String, String)	Validates if the attribute of the specified element contains a specific value.
	AttributeContains(RepoItemInfo, String, String, String)	Validates if the attribute of the element for the specified repository item contains a specific value.
	AttributeContains(IElement, String, String, String, ValidateOptions)	Validates if the attribute of the specified element contains a specific value.
	AttributeContains(IElement, String, String, String, Boolean)	Validates if the attribute of the specified element contains a specific value.
	AttributeContains(RepoItemInfo, String, String, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item contains a specific value.
	AttributeContains(RepoItemInfo, String, String, String, Boolean)	Validates if the attribute of the element for the specified repository item contains a specific value.
	AttributeEqual(IElement, String, Object)	Validates if the attribute of the specified element matches a specific value.
	AttributeEqual(RepoItemInfo, String, Object)	Validates if the attribute of the element for the specified repository item matches a specific value.
	AttributeEqual(IElement, String, Object, String)	Validates if the attribute of the specified element matches a specific value.
	AttributeEqual(RepoItemInfo, String, Object, String)	Validates if the attribute of the element for the specified repository item matches a specific value.
	AttributeEqual(IElement, String, Object, String, ValidateOptions)	Validates if the attribute of the specified element matches a specific value.
	AttributeEqual(IElement, String, Object, String, Boolean)	Validates if the attribute of the specified element matches a specific value.
	AttributeEqual(RepoItemInfo, String, Object, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item matches a specific value.
	AttributeEqual(RepoItemInfo, String, Object, String, Boolean)	Validates if the attribute of the element for the specified repository item matches a specific value.
	AttributeNotContains(IElement, String, String)	Validates if the attribute of the specified element does not contain the specific value.
	AttributeNotContains(RepoItemInfo, String, String)	Validates if the attribute of the element for the specified repository item does not contain the specific value.
	AttributeNotContains(IElement, String, String, String)	Validates if the attribute of the specified element does not contain the specific value.
	AttributeNotContains(RepoItemInfo, String, String, String)	Validates if the attribute of the element for the specified repository item does not contain the specific value.
	AttributeNotContains(IElement, String, String, String, ValidateOptions)	Validates if the attribute of the specified element does not contain the specific value.
	AttributeNotContains(IElement, String, String, String, Boolean)	Validates if the attribute of the specified element does not contain the specific value.
	AttributeNotContains(RepoItemInfo, String, String, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item does not contain the specific value.
	AttributeNotContains(RepoItemInfo, String, String, String, Boolean)	Validates if the attribute of the element for the specified repository item does not contain the specific value.
	AttributeNotEqual(IElement, String, Object)	Validates if the attribute of the specified element does not match a specific value.
	AttributeNotEqual(RepoItemInfo, String, Object)	Validates if the attribute of the element for the specified repository item does not match a specific value.
	AttributeNotEqual(IElement, String, Object, String)	Validates if the attribute of the specified element does not match a specific value.
	AttributeNotEqual(RepoItemInfo, String, Object, String)	Validates if the attribute of the element for the specified repository item does not match a specific value.
	AttributeNotEqual(IElement, String, Object, String, ValidateOptions)	Validates if the attribute of the specified element does not match a specific value.
	AttributeNotEqual(IElement, String, Object, String, Boolean)	Validates if the attribute of the specified element does not match a specific value.
	AttributeNotEqual(RepoItemInfo, String, Object, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item does not match a specific value.
	AttributeNotEqual(RepoItemInfo, String, Object, String, Boolean)	Validates if the attribute of the element for the specified repository item does not match a specific value.
	AttributeRegex(IElement, String, Regex)	Validates if the attribute of the specified element matches a specific regular expression.
	AttributeRegex(RepoItemInfo, String, Regex)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	AttributeRegex(IElement, String, Regex, String)	Validates if the attribute of the specified element matches a specific regular expression.
	AttributeRegex(RepoItemInfo, String, Regex, String)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	AttributeRegex(IElement, String, Regex, String, ValidateOptions)	Validates if the attribute of the specified element matches a specific regular expression.
	AttributeRegex(IElement, String, Regex, String, Boolean)	Validates if the attribute of the specified element matches a specific regular expression.
	AttributeRegex(RepoItemInfo, String, Regex, String, ValidateOptions)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	AttributeRegex(RepoItemInfo, String, Regex, String, Boolean)	Validates if the attribute of the element for the specified repository item matches a specific regular expression.
	CompareImage(Element, Bitmap, ImagingFindOptions)	Validates if the screenshot of the specified element matches the given image.
	CompareImage(RepoItemInfo, Bitmap, ImagingFindOptions)	Validates if the screenshot of the specified repository item matches the given image.
	CompareImage(Element, Bitmap, ImagingFindOptions, String)	Validates if the screenshot of the specified element matches the given image.
	CompareImage(RepoItemInfo, Bitmap, ImagingFindOptions, String)	Validates if the screenshot of the specified repository item matches the given image.
	CompareImage(Bitmap, Bitmap, ImagingFindOptions, String, ValidateOptions)	Compares two images to validate if they match within specified tolerance.
	CompareImage(Element, Bitmap, ImagingFindOptions, String, ValidateOptions)	Validates if the screenshot of the specified element matches the given image.
	CompareImage(Element, Bitmap, ImagingFindOptions, String, Boolean)	Validates if the screenshot of the specified element matches the given image.
	CompareImage(RepoItemInfo, Bitmap, ImagingFindOptions, String, ValidateOptions)	Validates if the screenshot of the specified repository item matches the given image.
	CompareImage(RepoItemInfo, Bitmap, ImagingFindOptions, String, Boolean)	Validates if the screenshot of the specified repository item matches the given image.
	ContainsImage(Element, Bitmap, ImagingFindOptions)	Validates if the screenshot of the specified element contains the given image.
	ContainsImage(RepoItemInfo, Bitmap, ImagingFindOptions)	Validates if the screenshot of the specified repository item contains the given image.
	ContainsImage(Element, Bitmap, ImagingFindOptions, String)	Validates if the screenshot of the specified element contains the given image.
	ContainsImage(RepoItemInfo, Bitmap, ImagingFindOptions, String)	Validates if the screenshot of the specified repository item contains the given image.
	ContainsImage(Element, Bitmap, ImagingFindOptions, String, ValidateOptions)	Validates if the screenshot of the specified element contains the given image.
	ContainsImage(Element, Bitmap, ImagingFindOptions, String, Boolean)	Validates if the screenshot of the specified element contains the given image.
	ContainsImage(RepoItemInfo, Bitmap, ImagingFindOptions, String, ValidateOptions)	Validates if the screenshot of the specified repository item contains the given image.
	ContainsImage(RepoItemInfo, Bitmap, ImagingFindOptions, String, Boolean)	Validates if the screenshot of the specified repository item contains the given image.
	Exists(String)	Validates if the element for the specified path exists using the DefaultSearchTimeout to keep looking for an element matching the path.
	Exists(Element)	Validates if the specified element exists.
	Exists(RepoItemInfo)	Validates if the element for the specified repository item exists.
	Exists(RxPath)	Validates if the element for the specified path exists using the DefaultSearchTimeout to keep looking for an element matching the path.
	Exists(String, Duration)	Validates if the element for the specified path exists.
	Exists(Element, String)	Validates if the specified element exists.
	Exists(RepoItemInfo, String)	Validates if the element for the specified repository item exists.
	Exists(RxPath, Duration)	Validates if the element for the specified path exists.
	Exists(String, Duration, String)	Validates if the element for the specified path exists.
	Exists(Element, String, ValidateOptions)	Validates if the specified element exists.
	Exists(Element, String, Boolean)	Validates if the specified element exists.
	Exists(RepoItemInfo, String, ValidateOptions)	Validates if the element for the specified repository item exists.
	Exists(RepoItemInfo, String, Boolean)	Validates if the element for the specified repository item exists.
	Exists(RxPath, Duration, String)	Validates if the element for the specified path exists.
	Exists(String, Duration, String, ValidateOptions)	Validates if the element for the specified path exists.
	Exists(String, Duration, String, Boolean)	Validates if the element for the specified path exists.
	Exists(RxPath, Duration, String, ValidateOptions)	Validates if the element for the specified path exists.
	Exists(RxPath, Duration, String, Boolean)	Validates if the element for the specified path exists.
	Fail	Always lets the validation fail.
	Fail(String)	Always lets the validation fail.
	Fail(String, ValidateOptions)	Always lets the validation fail.
	IsFalse(Boolean)	Validates if the given condition is false.
	IsFalse(Boolean, String)	Validates if the given condition is false.
	IsFalse(Boolean, String, ValidateOptions)	Validates if the given condition is false.
	IsFalse(Boolean, String, Boolean)	Validates if the given condition is false.
	IsTrue(Boolean)	Validates if the given condition is true.
	IsTrue(Boolean, String)	Validates if the given condition is true.
	IsTrue(Boolean, String, ValidateOptions)	Validates if the given condition is true.
	IsTrue(Boolean, String, Boolean)	Validates if the given condition is true.
	NotExists(String)	Validates if the element for the specified path does not exist using the DefaultSearchTimeout to keep looking for an element matching the path.
	NotExists(Element)	Validates if the specified element does not exist.
	NotExists(RepoItemInfo)	Validates if the element for the specified repository item does not exist.
	NotExists(RxPath)	Validates if the element for the specified path does not exist using the DefaultSearchTimeout to keep looking for an element matching the path.
	NotExists(String, Duration)	Validates if the element for the specified path does not exist.
	NotExists(Element, String)	Validates if the specified element does not exist.
	NotExists(RepoItemInfo, String)	Validates if the element for the specified repository item does not exist.
	NotExists(RxPath, Duration)	Validates if the element for the specified path does not exist.
	NotExists(String, Duration, String)	Validates if the element for the specified path does not exist.
	NotExists(Element, String, ValidateOptions)	Validates if the specified element does not exist.
	NotExists(Element, String, Boolean)	Validates if the specified element does not exist.
	NotExists(RepoItemInfo, String, ValidateOptions)	Validates if the element for the specified repository item does not exist.
	NotExists(RepoItemInfo, String, Boolean)	Validates if the element for the specified repository item does not exist.
	NotExists(RxPath, Duration, String)	Validates if the element for the specified path does not exist.
	NotExists(String, Duration, String, ValidateOptions)	Validates if the element for the specified path does not exist.
	NotExists(String, Duration, String, Boolean)	Validates if the element for the specified path does not exist.
	NotExists(RxPath, Duration, String, ValidateOptions)	Validates if the element for the specified path does not exist.
	NotExists(RxPath, Duration, String, Boolean)	Validates if the element for the specified path does not exist.

Top

Fields

	Name	Description
	DefaultMessage	Use the value of this property to specify that the default validation message should be used.

Top

Remarks

You can use the following variables in messages you pass to the Validate methods that are replaced by the following values depending on the result of the validation:

Variable	Value if validation succeeds	Value if the validation fails
"@ValidateRESULT@"	"succeeded"	"failed"
"@ValidateNOT@"	""	"not "
"@ValidateTRUENOT@"	"not "	""

For example, the following message will be transformed according to the outcome of the validation:

Copy

bool condition = true;
Validate.IsTrue(condition, "The validation @ValidateRESULT@.");

Reference

Ranorex Namespace