TestingOptions.CompareDocuments-Klasse

Verwenden Sie diese Klasse, um Optionen für den Vergleich von Dokumenten mit der VerifyDocumentsEquivalence-API zu konfigurieren.

Definition

Namespace: UiPath.Testing.API.Models

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

Syntax

Öffentliche Klasse TestingOptions : CompareDocuments

Konstruktoren

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments

Initialisiert eine neue Instanz der TestingOptions.CompareDocuments -Klasse.

Eigenschaften

AdditionalOutputFilePath String

Pfad zur zusätzlichen Ausgabedatei. Muss festgelegt werden, wenn es sich bei OutputDiffType um eine PDF-Datei handelt.

ContinueOnError Boolescher

Gibt an, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Methode einen Fehler auslöst. Dieser Parameter unterstützt nur boolesche Werte (true, false). Der Standardwert ist alse. Wenn der Parameter leer ist und ein Fehler ausgegeben wird, wird die Ausführung des Projekts angehalten. Wenn der Wert auf true gesetzt ist, wird die Ausführung des Projekts ungeachtet eines Fehlers fortgesetzt.

IgnoreIdenticalItems Boolescher

Wenn auf True festgelegt, werden identische Elemente beim Vergleich ignoriert. Dies ist nützlich beim Vergleichen statischer Objekte wie Wasserzeichen oder Header. Standardmäßig ist dies auf true festgelegt.

IgnoreImagesLocation Boolescher

Wenn auf true festgelegt, wird die Position eines Bilds in den verglichenen Dokumenten ignoriert. Standardmäßig ist dies auf false festgelegt.

IncludeImages Boolescher

Bei „true“ enthält der Vergleichsprozess auch Bilder. Standardmäßig ist dies auf true eingestellt.

OutputDiffType DocumentOutputDiffType

Der Typ, den Sie für die Rückgabe der Unterschiede zwischen den Dokumenten verwenden möchten.

OutputFilePath String

Der Ausgabepfad des Basisdokuments.

Regeln Liste<ComparisonRule>

Liste der anzuwendenden Regeln. Sie können vom Typ RegexRule oder WildcardRule sein.

WordSeparators String

Die Objekte als Zeichenfolgen, die Sie im Vergleichsprozess als Worttrennzeichen berücksichtigen möchten. Wenn die Dokumente, die Sie vergleichen, beispielsweise einen Punkt (.) oder umgekehrte Schrägstriche (/) zum Trennen von Wörtern verwenden, können Sie diese als Worttrennzeichen definieren.

Methoden

Mit diesen Methoden können Sie die Dokumentvergleichsoptionen konfigurieren.

WithContinueOnError

Konfigurieren Sie, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Methode einen Fehler ausgibt.

Definition

Namespace: UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Boolescher

Gibt an, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Methode einen Fehler auslöst. Dieser Parameter unterstützt nur boolesche Werte (true, false). Der Standardwert ist false. Wenn der Parameter leer ist und ein Fehler ausgegeben wird, wird die Ausführung des Projekts angehalten. Wenn der Wert auf true gesetzt ist, wird die Ausführung des Projekts ungeachtet eines Fehlers fortgesetzt.

WithGenerateHtml

Generiert eine HTML-Datei mit den hervorgehobenen Unterschieden, die zwischen den beiden Dokumenten oder Texten identifiziert wurden.

Definition

Namespace: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

Dateipfad String

Der Pfad der HTML-Datei, in der die beim Vergleichen der Dokumente oder Texte identifizierten Unterschiede gespeichert werden.

WithGeneratePDF

Erstellt neue PDF-Dateien mit den hervorgehobenen Unterschieden sowohl für das Ausgangsdokument als auch für das Zieldokument, die zum Vergleich mit dem Ausgangsdokument verwendet werden.

Definition

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 String

Der neue Pfad des Basisdokuments, in dem Sie die PDF-Datei speichern möchten, in der die ermittelten Unterschiede hervorgehoben wurden.

targetPath String

Der neue Pfad des Zieldokuments, in dem Sie die PDF-Datei speichern möchten, die die identifizierten Unterschiede hervorgehoben hat.

WithIgnoreIdenticalItems

Wenn auf True festgelegt, werden identische Zeilen beim Vergleich ignoriert. Dies ist insbesondere beim Vergleichen statischer Objekte wie Wasserzeichen oder Header nützlich.

Definition

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 Boolescher

Gibt an, ob identische Elemente beim Vergleich ignoriert werden sollen. Standardmäßig ist dieser Parameter auf true festgelegt.

WithIgnoreImagesPageAndPosition

Bei „true“ werden die Position und Seite eines Bilds ignoriert.

Definition

Namespace: UiPath.Testing.API.Models

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

WithIgnoreImagesPageAndPosition(this, bool)

WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)

ignoreImagesPageAndPosition Boolescher

Wenn auf true festgelegt, werden die Position und Seite eines Bilds ignoriert. Standardmäßig ist der Wert des Parameters false.

WithIgnoreRegexRule

Wenn auf True festgelegt, wird jede Regex-Regel ignoriert, die Sie für den Parameter Rules konfiguriert haben. Auf diese Weise können Sie bestimmte Teile der Texte oder Dokumente ausschließen, die Sie vergleichen.

Definition

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 String

Der Name der Regel, wie Sie sie in der Liste von Rules konfiguriert haben, die Sie im Vergleichsprozess ignorieren möchten.

regexPattern String

Der tatsächliche reguläre Ausdruck, der der zuvor eingegebene ruleName darstellt.

usePlaceholder Boolescher Wert (Optional)

Wenn auf True festgelegt, ersetzt er den ignorierten Teil eines Dokuments oder Texts durch einen Platzhalterwert. Der Platzhalterwert ist ruleName. Standardmäßig ist dieser Parameter auf true festgelegt.

WithIgnoreWildcardRule

Wenn auf True festgelegt, werden Platzhalterregeln ignoriert, die Sie für den Parameter Rules konfiguriert haben. Auf diese Weise können Sie bestimmte Teile der Texte oder Dokumente ausschließen, die Sie vergleichen.

Definition

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 String

Der Name der Regel, wie Sie sie in der Liste von Rules konfiguriert haben, die Sie im Vergleichsprozess ignorieren möchten.

wildcardPattern String

Der tatsächliche Platzhalter, der den zuvor eingegebenen ruleName darstellt.

usePlaceholder Boolescher Wert (Optional)

Wenn auf True festgelegt, ersetzt er den ignorierten Teil eines Dokuments oder Texts durch einen Platzhalterwert. Der Platzhalterwert ist ruleName. Standardmäßig ist dieser Parameter auf true festgelegt.

WithIncludeImages

Bezieht Bilder in den Vergleichsprozess mit ein. Wenn Sie diese Methode auf True festlegen, werden bei der Überprüfung der Äquivalenz zwischen Dokumenten oder Texten auch Bilder verglichen.

Definition

Namespace: UiPath.Testing.API.Models

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

WithIncludeImages(bool)

WithIncludeImages(
    bool includeImages
)

includeImages Boolescher

Wenn auf True festgelegt, vergleicht die API auch Bilder bei der Überprüfung der Äquivalenz zwischen Dokumenten und Texten.

WithWordSeparators

Geben Sie die Zeichen an, die Sie als Worttrennzeichen definieren möchten. Die Zeichen müssen in einer Zeichenfolge gespeichert werden.

Definition

Namespace: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators String

Die Zeichenfolge, die die Zeichen enthält, die Sie als Worttrennzeichen berücksichtigen möchten.