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.

ContinueOnError 布尔值

指定在方法抛出错误时是否应继续自动化。 此参数仅支持布尔值（ true和false ）。 默认值为alse 。 因此，如果参数为空且活动引发错误，系统将停止执行项目。 如果该值设为true ，则无论出现何种错误，系统都将继续执行项目。

IgnoreIdenticalItems 布尔值

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 布尔值

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

IncludeImages 布尔值

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.

规则 列表<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 布尔值

指定在方法抛出错误时是否应继续自动化。 此参数仅支持布尔值（ 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 布尔值

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 布尔值

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 布尔值(可选)

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 布尔值(可选)

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 布尔值

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.