TestingOptions.CompareText Class

Use this class to configure options for comparing documents with the VerifyTextEquivalence API.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

Syntax

public class TestingOptions : CompareText

Constructors

public TestingOptions.CompareDocuments()

TestingOptions.CompareText

Initializes a new instance of the TestingOptions.CompareText class.

Properties

AdditionalOutputFilePath String

Path to the additional output file. Needs to be set if OutputDiffType is PDF.

ContinueOnError Boolean

Specifies if the automation should continue even when the method throws an error.

OutputDiffType DocumentOutputDiffType

The format in which you want to show the differences between texts.

OutputFilePath String

The path to the output file that shows the differences between texts.

Rules List<ComparisonRule>

List of rules to be applied. They can be of type RegexRule or WildcardRule.

WordSeparators String

The characters that should be considered as word separators in the comparison process. For example, if the texts you are comparing commonly use a period (.) or backslashes (/) for separating words, then you can define these as word separators. By default, the separators are ". , ! ? : \n".

Methods

These are the methods you can use to configure the text comparison options.

WithContinueOnError

Configure if the automation should continue even when the method throws an error.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Boolean

Specifies if the automation should continue even when the method throws an error. This parameter only supports Boolean values (true, false). The default value is false. As a result, if the parameter is blank and an error is thrown, the execution of the project stops. If the value is set to true, the execution of the project continues regardless of any error.

WithGenerateHtml

Generates an HTML file with the highlighted differences identified between the two documents or texts.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

filePath String

The path of the HTML file that stores the differences identified when comparing the documents or texts.

WithIgnoreRegexRule

If set to True, ignores any Regex rule that you configured for the Rules parameter. This allows you to exclude certain parts of the texts or documents that you are comparing.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIgnoreRegexRule(string, string, [bool])

WithIgnoreRegexRule(
    string ruleName,
    string regexPattern,
    [bool usePlaceholders = true]
)

ruleName String

The name of the rule, as you configured it in the list of Rules, that you want to ignore in the comparison process.

regexPattern String

The actual regex that represents the ruleName previously entered.

usePlaceholder Boolean (Optional)

If set to True it replaces the ignored part of a document or text with a placeholder value. The placeholder value is the ruleName. By default, this parameter is set to true.

WithIgnoreWildcardRule

If set to True, ignores any wild card rule that you configured for the Rules parameter. This allows you to exclude certain parts of the texts or documents that you are comparing.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIgnoreWildcardRule(string, string, bool)

WithIgnoreWildcardRule(
    string ruleName,
    string wildcardPattern,
    [bool usePlaceholder = true]
)

ruleName String

The name of the rule, as you configured it in the list of Rules, that you want to ignore in the comparison process.

wildcardPattern String

The actual wildcard that represents the ruleName previously entered.

usePlaceholder Boolean (Optional)

If set to True it replaces the ignored part of a document or text with a placeholder value. The placeholder value is the ruleName. By default, this parameter is set to true.

WithWordSeparators

Specify the characters that you want to define as word separators. The characters must be stored in a string.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators String

The string containing the characters that you want to consider as word separators.