TestingOptions.CompareText Class

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

Definición

Namespace: UiPath.Testing.API.Models

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

Sintaxis

public class TestingOptions : CompareText

Constructores

public TestingOptions.CompareDocuments()

TestingOptions.CompareText

Inicializa una nueva instancia de la clase TestingOptions.CompareText .

Propiedades

AdditionalOutputFilePath Cadena

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

ContinueOnError Booleano

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 Cadena

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

Reglas Lista<ComparisonRule>

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

WordSeparators Cadena

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".

Métodos

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.

Definición

Namespace: UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Booleano

Especifica si la automatización debe continuar incluso cuando el método arroja un error. Este parámetro solo admite valores booleanos (true, false). El valor predeterminado es false. Como resultado, si el parámetro está en blanco y se produce un error, la ejecución del proyecto se detiene. Si el valor se establece en true, la ejecución del proyecto continúa independientemente de cualquier error.

WithGenerateHtml

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

Definición

Namespace: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

Ruta del archivo Cadena

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.

Definición

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 Cadena

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

regexPattern Cadena

The actual regex that represents the ruleName previously entered.

usePlaceholder Booleano (opcional)

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.

Definición

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 Cadena

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

wildcardPattern Cadena

The actual wildcard that represents the ruleName previously entered.

usePlaceholder Booleano (opcional)

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.

Definición

Namespace: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators Cadena

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