TestingOptions.CompareDocuments Class

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

定義

Namespace: UiPath.Testing.API.Models

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

構文

public class TestingOptions : CompareDocuments

コンストラクター

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments

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

プロパティ

AdditionalOutputFilePath 文字列

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

エラー発生時に実行を継続 Boolean

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

IgnoreIdenticalItems Boolean

If set to True, identical items are ignored during comparison. This is useful when comparing static objects, such as watermarks or headers. By default, this is set to true.

IgnoreImagesLocation Boolean

If set to true, ignores the location of an image in the compared documents. By default, this is set to false.

IncludeImages Boolean

If set to true, the comparison process includes images, as well. By default, this is set to true.

OutputDiffType DocumentOutputDiffType

The type you want to use for returning the differences between the documents.

OutputFilePath 文字列

The output path of the base document.

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

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

WordSeparators 文字列

The objects, as Strings, that you want to consider as word separators in the comparison process. For example, if the documents you are comparing commonly use a period (.) or backslashes (/) for separating words, then you can define these as word separators.

メソッド

These are the methods you can use to configure the document 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.

WithGeneratePDF

Generates new PDF files with the highlighted differences for both the baseline document and the target document, used to compare against the baseline document.

定義

Namespace: UiPath.Testing.API.Models

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

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath 文字列

The new path of the baseline document, where you want to store the PDF file that highlighted the identified differences.

targetPath 文字列

The new path of the target document, where you want to store the PDF file that highlighted the identified differences.

WithIgnoreIdenticalItems

If set to True, identical lines are ignored during comparison. This is useful, in particular, when comparing static objects, such as watermarks or headers.

定義

Namespace: UiPath.Testing.API.Models

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

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Boolean

Specifies if identical items should be ignored during comparison. By default, this parameter is set to true.

WithIgnoreImagesPageAndPosition

If set to true, ignores the position and page of an image.

定義

Namespace: UiPath.Testing.API.Models

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

WithIgnoreImagesPageAndPosition(this, bool)

WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)

ignoreImagesPageAndPosition Boolean

If set to true, ignores the position and page of an image. By default, the value of the parameter is false.

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.

WithIncludeImages

Includes images in the comparison process. If you set this method to True, it also compares images, when verifying the equivalence between documents or texts.

定義

Namespace: UiPath.Testing.API.Models

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

WithIncludeImages(bool)

WithIncludeImages(
    bool includeImages
)

includeImages Boolean

If set to True, the API also compares images when verifying the equivalence between documents and texts.

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.