Classe OptionsTest.CompareDocuments

Utilisez cette classe pour configurer les options de comparaison de documents avec l’API VérifierÉquivalenceDocuments (VerifyDocumentsEquivalence).

Définition

Espace de noms:  UiPath.Testing.API.Models

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

Syntaxe

classe publique OptionsTest (TestingOptions) : ComparerDocuments (CompareDocuments)

Constructeurs

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments

Initialise une nouvelle instance de la classe TestingOptions.CompareDocuments .

Propriétés

AdditionalOutputFilePath Chaîne de caractères (string)

Chemin d’accès au fichier de sortie supplémentaire. Doit être défini si la valeur OutputDiffType est PDF.

ContinueOnError Booléen

Précise si l’automatisation doit se poursuivre même si la méthode génère une erreur. Ce paramètre prend uniquement en charge les valeurs booléennes (true, false). La valeur par défaut est alse. Par conséquent, si le paramètre est vide et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au true, l'exécution du projet se poursuit même en cas d'erreur.

IgnoreIdenticalItems Booléen

Si défini sur True, les éléments identiques sont ignorés lors de la comparaison. Cela est utile lors de la comparaison d’objets statiques, tels que des filigranes ou des en-têtes. Par défaut, ce paramètre est défini sur true.

IgnoreImagesLocation Booléen

Si défini sur true, ignore l’emplacement d’une image dans les documents comparés. Par défaut, ce paramètre est défini sur false.

IncludeImages Booléen

Si réglé sur Vrai, le processus de comparaison inclut également les images. Par défaut, cette option est configurée sur true.

OutputDiffType DocumentOutputDiffType

Le type que vous souhaitez utiliser pour renvoyer les différences entre les documents.

OutputFilePath Chaîne de caractères (string)

Le chemin de sortie du document de base.

Règles List<ComparisonRule>

Liste des règles à appliquer. Elles peuvent être de type RegexRule ou WildcardRule.

WordSeparators Chaîne de caractères (string)

Les objets, sous la forme de chaînes, que vous souhaitez prendre en compte comme séparateurs de mots dans le processus de comparaison. Par exemple, si les documents que vous comparez utilisent généralement un point (.) ou une barre oblique inverse (/) pour séparer des mots, vous pouvez définir ces caractères comme séparateurs de mots.

Méthodes

Voici les méthodes que vous pouvez utiliser pour configurer les options de comparaison de documents.

WithContinueOnError

Configurez si l’automatisation doit se poursuivre même lorsque la méthode génère une erreur.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Booléen

Précise si l’automatisation doit se poursuivre même si la méthode génère une erreur. Ce paramètre prend uniquement en charge les valeurs booléennes (true, false). La valeur par défaut est false. Par conséquent, si le paramètre est vide et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au true, l'exécution du projet se poursuit même en cas d'erreur.

WithGenerateHtml

Génère un fichier HTML avec les différences mises en évidence entre les deux documents ou textes.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

CheminFichier Chaîne de caractères (string)

Le chemin d’accès au fichier HTML qui stocke les différences identifiées lors de la comparaison des documents ou des textes.

WithGeneratePDF

Génère de nouveaux fichiers PDF avec les différences mises en évidence pour le document de base et le document cible, utilisés pour effectuer la comparaison avec le document de base.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath Chaîne de caractères (string)

Le nouveau chemin d’accès du document de base, où vous souhaitez stocker le fichier PDF qui a mis en évidence les différences identifiées.

targetPath Chaîne de caractères (string)

Le nouveau chemin d’accès au document cible, où vous souhaitez stocker le fichier PDF qui a mis en évidence les différences identifiées.

WithIgnoreIdenticalItems

Si défini sur True, les lignes identiques sont ignorées lors de la comparaison. Ce point est particulièrement utile lors de la comparaison d’objets statiques, tels que des filigranes ou des en-têtes.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Booléen

Spécifie si des éléments identiques doivent être ignorés lors de la comparaison. Par défaut, ce paramètre est défini sur true.

WithIgnoreImagesPageAndPosition

Si défini sur Vrai (True), ignore la position et la page d’une image.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIgnoreImagesPageAndPosition(this, bool)

WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)

ignoreImagesPageAndPosition Booléen

Si défini sur true, ignore la position et la page d’une image. Par défaut, la valeur du paramètre est false.

WithIgnoreRegexRule

Si défini sur True, ignore toute règle Regex que vous avez configurée pour le paramètre Rules. Cela vous permet d’exclure certaines parties des textes ou des documents que vous comparez.

Définition

Espace de noms:  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 Chaîne de caractères (string)

Le nom de la règle, tel que configuré dans la liste de Rules, que vous voulez ignorer dans le processus de comparaison.

regexPattern Chaîne de caractères (string)

L’expression régulière réelle qui représente l’objet ruleName précédemment saisi.

usePlaceholder Booléen (facultatif)

Si défini sur True, remplace la partie ignorée d’un document ou d’un texte par une valeur d’espace réservé. La valeur de l’espace réservé est ruleName. Par défaut, ce paramètre est défini sur true.

WithIgnoreWildcardRule

Si défini sur True, ignore toute règle de caractère générique que vous avez configurée pour le paramètre Rules. Cela vous permet d’exclure certaines parties des textes ou des documents que vous comparez.

Définition

Espace de noms:  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 Chaîne de caractères (string)

Le nom de la règle, tel que configuré dans la liste de Rules, que vous voulez ignorer dans le processus de comparaison.

wildcardPattern Chaîne de caractères (string)

Le caractère générique réel qui représente l’objet ruleName précédemment saisi.

usePlaceholder Booléen (facultatif)

Si défini sur True, remplace la partie ignorée d’un document ou d’un texte par une valeur d’espace réservé. La valeur de l’espace réservé est ruleName. Par défaut, ce paramètre est défini sur true.

WithIncludeImages

Inclut des images dans le processus de comparaison. Si vous définissez cette méthode sur True, les images sont également comparées lors de la vérification de l’équivalence entre des documents ou des textes.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIncludeImages(bool)

WithIncludeImages(
    bool includeImages
)

includeImages Booléen

Si défini sur True, l’API compare également les images lors de la vérification de l’équivalence entre des documents et des textes.

WithWordSeparators

Spécifiez les caractères que vous souhaitez définir comme séparateurs de mots. Les caractères doivent être stockés dans une chaîne.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators Chaîne de caractères (string)

La chaîne contenant les caractères à prendre en compte comme séparateurs de mots.