activities

latest

false

重要 :

请注意，此内容已使用机器翻译进行了部分本地化。新发布内容的本地化可能需要 1-2 周的时间才能完成。

工作流活动

上次更新日期 2026年3月3日

TestingOptions.CompareDocuments 类

使用此类可配置选项，以便使用ComparePdfDocuments编码自动化 API 进行文档比较。

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

语法

public class TestingOptions : CompareDocuments
public class TestingOptions : CompareDocuments

构造函数

public TestingOptions.CompareDocuments()
public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments ：初始化TestingOptions.CompareDocuments类的新实例。

属性

AdditionalOutputFilePath String : 附加输出文件的路径。如果OutputDiffType是 PDF，则需要设置。

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

GenerateSemanticResult Boolean ：使用 Autopilot ^TM提供的 AI 功能执行验证，以获取差异的语义解释。这将生成具有语义差异的其他结果。

备注：

根据您注册的许可计划，每次执行编码自动化 API 时，语义结果类型都会消耗以下资源之一：

对于 Flex 许可计划，语义结果类型会消耗一个 AI Unit。
对于 Unified Pricing 许可计划，语义结果类型消耗一个平台单元。有关消耗的更多信息，请访问关于测试活动包。

IgnoreIdenticalItems Boolean ：如果设置为True ，则在比较过程中将忽略相同的项目。这在比较静态对象（例如水印或标头）时非常有用。默认情况下，这设置为True 。

IgnoreWidgetsLocation Boolean ：如果设置为True ，则忽略图像或 URL 在所比较文档中的位置。默认情况下，这设置为False 。

IncludeWidgets Boolean ：如果设置为True ，则比较过程还包括图像和 URL。默认情况下，这设置为True 。

OutputDiffType DocumentOutputDiffType ：要用于返回文档之间差异的类型。

OutputFilePath String : 基本文档的输出路径。

Rules List<ComparisonRule> ：要应用的规则列表。它们的类型可以是RegexRule或WildcardRule 。

WordSeparators String ：要在比较流程中视为单词分隔符的对象（如字符串）。例如，如果您要比较的文档通常使用句点.或反斜杠/来分隔单词，则您可以将其定义为单词分隔符。

方法

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

WithContinueOnError

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithContinueOnError(bool)`

WithIgnoreRegexRule(
    bool continueOnError
)
WithIgnoreRegexRule(
    bool continueOnError
)

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

WithGenerateHtml

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithGenerateHtml(string)`

WithGenerateHtml(
    string filePath
)
WithGenerateHtml(
    string filePath
)

filePath String ：HTML 文件的路径，该文件用于存储在比较文档或文本时发现的差异。

WithGeneratePDF

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithGeneratePDF(string, string)`

WithGeneratePDF(
    string baselinePath,
    string targetPath
)
WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath字符串：基线文档的新路径，用于存储高亮显示已识别差异的 PDF 文件。

targetPath String ：目标文档的新路径，用于存储高亮显示已识别差异的 PDF 文件。

WithGenerateSemanticResult

使用 Autopilot ^TM提供的 AI 功能执行验证，以获得差异的语义解释。这将生成具有语义差异的其他结果。

备注：

根据您注册的许可计划，每次执行编码自动化 API 时，语义结果类型都会消耗以下资源之一：

对于 Flex 许可计划，语义结果类型会消耗一个 AI Unit。
对于 Unified Pricing 许可计划，语义结果类型消耗一个平台单元。有关消耗的更多信息，请访问关于测试活动包。

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithGenerateSemanticResult(bool)`

WithGenerateSemanticResult(
    bool generateSemanticResult = false
)
WithGenerateSemanticResult(
    bool generateSemanticResult = false
)

generateSemanticResult布尔值：如果设置为true ，则使用 AI 功能执行验证。默认情况下，这设置为false 。

返回值

SemanticDifferences

使用 AI 功能执行的验证流程的结果。

WithIgnoreIdenticalItems

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithIgnoreIdenticalItems(bool)`

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)
CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Boolean ：指定在比较过程中是否应忽略相同项目。默认情况下，此参数设置为true 。

WithIgnoreWidgetsPageAndPosition

如果设置为 true，则忽略图像或 URL 的位置和页面。

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithIgnoreWidgetsPageAndPosition(this, bool)`

WithIgnoreWidgetsPageAndPosition(
    bool ignoreWidgetsPageAndPosition = false
)
WithIgnoreWidgetsPageAndPosition(
    bool ignoreWidgetsPageAndPosition = false
)

ignoreWidgetsPageAndPosition Boolean ：如果设置为true ，则忽略图像或 URL 的位置和页面。默认情况下，参数值为false 。

WithIgnoreRegexRule

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 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 String ：要在比较过程中忽略的规则名称（即您在Rules列表中配置的名称）。

regexPattern String ：表示先前输入的ruleName的实际正则表达式。

usePlaceholder布尔值（可选）：如果设置为True则它会将文档或文本中被忽略的部分替换为占位符值。占位符值为ruleName 。默认情况下，此参数设置为true 。

WithIgnoreWildcardRule

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 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 String ：要在比较过程中忽略的规则名称（即您在Rules列表中配置的名称）。

wildcardPattern String ：表示先前输入的ruleName的实际通配符。

WithIncludeWidgets

将图像和 URL 添加到比较流程中。如果将此方法设置为True ，则在验证文档或文本之间的等效性时，它还会比较图像和 URL。

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithIncludeWidgets(bool)`

WithIncludeWidgets(
    bool includeWidgets
)
WithIncludeWidgets(
    bool includeWidgets
)

includeWidgets Boolean ：如果设置为True ，则编码自动化 API 在验证文档和文本之间的等效性时还会比较图像和 URL。

WithWordSeparators

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

定义

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

程序集：UiPath.Testing.Activities.Api（在 UiPath.Testing.Activities.Api.dll 中）

`WithWordSeparators(string)`

WithWordSeparators(
    string wordSeparators
)
WithWordSeparators(
    string wordSeparators
)

wordSeparators String ：包含要用作单词分隔符的字符的字符串。

此页面有帮助吗？

前一个比较 PDF 文档

下一个比较文本

工作流活动

定义​

语法​

构造函数​

属性​

方法​

WithContinueOnError​

定义​

WithContinueOnError(bool)​

WithGenerateHtml​

定义​

WithGenerateHtml(string)​

WithGeneratePDF​

定义​

WithGeneratePDF(string, string)​

WithGenerateSemanticResult​

定义​

WithGenerateSemanticResult(bool)​

返回值​

WithIgnoreIdenticalItems​

定义​

WithIgnoreIdenticalItems(bool)​

WithIgnoreWidgetsPageAndPosition​

定义​

WithIgnoreWidgetsPageAndPosition(this, bool)​

WithIgnoreRegexRule​

定义​

WithIgnoreRegexRule(string, string, [bool])​

WithIgnoreWildcardRule​

定义​

WithIgnoreWildcardRule(string, string, bool)​

WithIncludeWidgets​

定义​

WithIncludeWidgets(bool)​

WithWordSeparators​

定义​

WithWordSeparators(string)​

此页面有帮助吗？

定义

语法

构造函数

属性

方法

WithContinueOnError

定义

`WithContinueOnError(bool)`

WithGenerateHtml

定义

`WithGenerateHtml(string)`

WithGeneratePDF

定义

`WithGeneratePDF(string, string)`

WithGenerateSemanticResult

定义

`WithGenerateSemanticResult(bool)`

返回值

WithIgnoreIdenticalItems

定义

`WithIgnoreIdenticalItems(bool)`

WithIgnoreWidgetsPageAndPosition

定义

`WithIgnoreWidgetsPageAndPosition(this, bool)`

WithIgnoreRegexRule

定义

`WithIgnoreRegexRule(string, string, [bool])`

WithIgnoreWildcardRule

定义

`WithIgnoreWildcardRule(string, string, bool)`

WithIncludeWidgets

定义

`WithIncludeWidgets(bool)`

WithWordSeparators

定义

`WithWordSeparators(string)`