TestingOptions.CompareDocuments クラス

このクラスを使用して、ドキュメントを VerifyDocumentsEquivalence API と比較するためのオプションを設定します。

定義

名前空間: 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 文字列

追加の出力ファイルへのパスです。OutputDiffType が PDF の場合は設定する必要があります。

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

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

IgnoreIdenticalItems Boolean

true に設定すると、比較時に同一の項目が無視されます。これは、ウォーターマークやヘッダーなどの静的オブジェクトを比較するときに便利です。既定では true に設定されています。

IgnoreImagesLocation Boolean

true に設定すると、比較対象のドキュメント内の画像の場所が無視されます。既定では false に設定されています。

IncludeImages Boolean

true に設定すると、画像も比較されます。 既定では、true に設定されています。

OutputDiffType DocumentOutputDiffType

ドキュメント間の差分を返すために使用する型です。

OutputFilePath 文字列

ベース ドキュメントの出力パスです。

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

適用するルールのリスト。RegexRule 型または WildcardRule 型のいずれかです。

WordSeparators 文字列

比較時に単語の区切り文字と見なされるようにするオブジェクト (文字列) です。たとえば、比較対象のドキュメントで単語を区切るためにピリオド (.) またはバックスラッシュ (/) を使用する場合は、これらを単語の区切り文字として定義できます。

メソッド

これらは、ドキュメント比較オプションを設定するために使用できる方法です。

WithContinueOnError

メソッドが例外をスローした場合でもオートメーションを継続するかどうかを設定します。

定義

名前空間: 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

2 つのドキュメントまたはテキスト間で特定された差分を強調表示した HTML ファイルを生成します。

定義

名前空間: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

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
)

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
)

ignoreIdenticalItems Boolean

同一の項目を比較時に無視するかどうかを指定します。既定では、このパラメーターは 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
)

ignoreImagesPageAndPosition Boolean

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]
)

ruleName 文字列

Rules のリストで設定した、比較時に無視するルールの名前です。

regexPattern 文字列

前に入力した ruleName を表す実際の正規表現です。

usePlaceholder Boolean (任意)

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]
)

ruleName 文字列

Rules のリストで設定した、比較時に無視するルールの名前です。

wildcardPattern 文字列

前に入力した ruleName を表す実際のワイルドカードです。

usePlaceholder Boolean (任意)

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
)

includeImages Boolean

true に設定すると、ドキュメントとテキストの等価性を検証するときに、API は画像も比較します。

WithWordSeparators

単語の区切り文字として定義する文字を指定します。文字は文字列に保存される必要があります。

定義

名前空間: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators 文字列

単語の区切り文字と見なす文字を含む文字列です。