TestingOptions.CompareText Class

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

定義

Namespace: UiPath.Testing.API.Models

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

構文

public class TestingOptions : CompareText

コンストラクター

public TestingOptions.CompareDocuments()

TestingOptions.CompareText

TestingOptions.CompareText クラスの新しいインスタンスを初期化します。

プロパティ

AdditionalOutputFilePath 文字列

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

エラー発生時に実行を継続 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 文字列

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

ルール リスト (List)<ComparisonRule>

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

WordSeparators 文字列

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

メソッド

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.

定義

Namespace: UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Boolean

メソッドが例外をスローした場合でも、オートメーションを継続するかどうかを指定します。このパラメーターでは Boolean 値 (true、false) のみサポートされています。既定値は false です。その結果、パラメーターが空白の場合にエラーが発生すると、プロジェクトの実行が停止します。値を true に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

WithGenerateHtml

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

定義

Namespace: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

ファイル パス 文字列

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.

定義

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 文字列

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

regexPattern 文字列

The actual regex that represents the ruleName previously entered.

usePlaceholder Boolean (任意)

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.

定義

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 文字列

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

wildcardPattern 文字列

The actual wildcard that represents the ruleName previously entered.

usePlaceholder Boolean (任意)

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.

定義

Namespace: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators 文字列

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