activities
latest
false
重要 :
请注意此内容已使用机器翻译进行了部分本地化。
UiPath logo, featuring letters U and I in white
工作流活动
Last updated 2024年12月6日

TestingOptions.CompareDocuments 类

使用此类可配置用于与验证文档当量 API 进行文档比较的选项。

定义

命名空间:UiPath.Testing.API.Models

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

语法

公共测试选项比较文档public class TestingOptions : CompareDocuments

构造函数

public TestingOptions.CompareDocuments()public TestingOptions.CompareDocuments()
TestingOptions.CompareDocuments
初始化“ TestingOptions.CompareDocuments ”类的新实例。

属性

AdditionalOutputFilePath 字符串
到其他输出文件的路径。如果 OutputDiffType 是 PDF,则需要设置。
ContinueOnError 布尔值
指定在方法抛出错误时是否应继续自动化。 此参数仅支持布尔值( truefalse )。 默认值为alse 。 因此,如果参数为空且活动引发错误,系统将停止执行项目。 如果该值设为true ,则无论出现何种错误,系统都将继续执行项目。
IgnoreIdenticalItems 布尔值
如果设置为 True,则在比较过程中会忽略相同的项目。这在比较静态对象(例如水印或标头)时非常有用。默认情况设置为 true
IgnoreImagesLocation 布尔值
如果设置为 true,则忽略图像在所比较文档中的位置。默认情况设置为 false
IncludeImages 布尔值
如果设置为 “true”,则比较过程也会包括图像。 默认情况下,此设置为 true
OutputDiffType DocumentOutputDiffType
要用于返回文档之间差异的类型。
OutputFilePath 字符串
基本文档的输出路径。
规则 列表<ComparisonRule>
要应用的规则列表。它们的类型可以是 RegexRuleWildcardRule
WordSeparators 字符串
要在比较流程中视为单词分隔符的字符串等对象。例如,如果您要比较的文档通常使用句点 (.) 或反斜杠 (/) 来分隔单词,则您可以将其定义为单词分隔符。

方法

您可以使用这些方法来配置文档比较选项。

WithContinueOnError

配置在该方法引发错误时是否应继续自动化。

定义

命名空间:UiPath.Testing.API.Models

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

WithContinueOnError(bool)

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

WithGenerateHtml

生成一个 HTML 文件,其中高亮显示两个文档或文本之间识别的差异。

定义

命名空间:UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)WithGenerateHtml(
    string filePath
)
文件路径 字符串
HTML 文件的路径,该文件用于存储比较文档或文本时识别的差异。

WithGeneratePDF

生成新的 PDF 文件,其中高亮显示基线文档和目标文档的差异,用于与基线文档进行比较。

定义

命名空间:UiPath.Testing.API.Models

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

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)WithGeneratePDF(
    string baselinePath,
    string targetPath
)
baselinePath 字符串
基线文档的新路径,您要在其中存储高亮显示已识别差异的 PDF 文件。
targetPath 字符串
目标文档的新路径,用于存储高亮显示已识别差异的 PDF 文件。

WithIgnoreIdenticalItems

如果设置为 True,则在比较过程中会忽略相同的行。这尤其在比较静态对象(例如水印或标头)时非常有用。

定义

命名空间:UiPath.Testing.API.Models

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

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)
ignoreIdenticalItems 布尔值
指定在比较过程中是否应忽略相同项目。默认情况下,此参数设置为 true

WithIgnoreImagesPageAndPosition

如果设置为“true”,则忽略图像的位置和页面。

定义

命名空间:UiPath.Testing.API.Models

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

WithIgnoreImagesPageAndPosition(this, bool)

WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)
ignoreImagesPageAndPosition 布尔值
如果设置为 true,则忽略图像的位置和页面。默认情况下,参数值为 false

WithIgnoreRegexRule

如果设置为 True,则忽略您为 Rules 参数配置的任何正则表达式规则。这使您可以排除要比较的文本或文档的某些部分。

定义

命名空间: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]
)WithIgnoreRegexRule(
    string ruleName,
    string regexPattern,
    [bool usePlaceholders = true]
)
ruleName 字符串
要在比较过程中忽略的规则名称(在 Rules 列表中配置)。
regexPattern 字符串
表示先前输入的 ruleName 的实际正则表达式。
usePlaceholder 布尔值(可选)
如果设置为 True,则它会将文档或文本中被忽略的部分替换为占位符值。占位符值为 ruleName。默认情况下,此参数设置为 true

WithIgnoreWildcardRule

如果设置为 True,则忽略您为 Rules 参数配置的任何通配符规则。这使您可以排除要比较的文本或文档的某些部分。

定义

命名空间: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]
)WithIgnoreWildcardRule(
    string ruleName,
    string wildcardPattern,
    [bool usePlaceholder = true]
)
ruleName 字符串
要在比较过程中忽略的规则名称(在 Rules 列表中配置)。
wildcardPattern 字符串
表示先前输入的 ruleName 的实际通配符。
usePlaceholder 布尔值(可选)
如果设置为 True,则它会将文档或文本中被忽略的部分替换为占位符值。占位符值为 ruleName。默认情况下,此参数设置为 true

WithIncludeImages

将图像纳入比较流程。如果将此方法设置为 True,则在验证文档或文本之间的等效性时,它还会比较图像。

定义

命名空间:UiPath.Testing.API.Models

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

WithIncludeImages(bool)

WithIncludeImages(
    bool includeImages
)WithIncludeImages(
    bool includeImages
)
includeImages 布尔值
如果设置为 True,则 API 在验证文档和文本之间的等效性时也会比较图像。

WithWordSeparators

指定要定义为单词分隔符的字符。字符必须存储在字符串中。

定义

命名空间:UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)WithWordSeparators(
    string wordSeparators
)
wordSeparators 字符串
此为包含要视为单词分隔符的字符的字符串。

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。