Classe TestingOptions.CompareDocuments

Use essa classe para configurar opções para comparar documentos com a API VerificarEquivalênciaDocumentos.

Definição

Namespace: UiPath.Testing.API.Models

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

Sintaxe

classe pública OpçõesDeTeste : CompararDocumentos

Construtores

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments

Inicializa uma nova instância de classe TestingOptions.CompareDocuments .

Propriedades

AdditionalOutputFilePath String

Caminho para o arquivo de saída adicional. Precisa ser definido se OutputDiffType for PDF.

ContinueOnError Booleano

Especifica se a automação deve continuar mesmo quando o método gera um erro. Este parâmetro só aceita valores booleanos (true, false). O valor padrão é alse. Como resultado, se o parâmetro estiver em branco e um erro for gerado, a execução do projeto será interrompida. Se o valor for definido como true, a execução do projeto continua independentemente de qualquer erro.

IgnoreIdenticalItems Booleano

Se definido como True, itens idênticos serão ignorados durante a comparação.Isso é útil ao comparar objetos estáticos, como marcas d'água ou cabeçalhos. Por padrão, esse parâmetro é definido como true.

IgnoreImagesLocation Booleano

Se definido como true, ignora o local de uma imagem nos documentos comparados. Por padrão, esse parâmetro é definido como false.

IncludeImages Booleano

Se definido como verdadeiro, o processo de comparação também inclui imagens. Por padrão, esse parâmetro é definido como true.

OutputDiffType DocumentOutputDiffType

O tipo que você deseja usar para retornar as diferenças entre os documentos.

OutputFilePath String

O caminho de saída do documento base.

Regras List<ComparisonRule>

Lista de regras a serem aplicadas. Elas podem ser do tipo RegexRule ou WildcardRule.

WordSeparators String

Os objetos, como Strings, que você deseja considerar como separadores de palavras no processo de comparação. Por exemplo, se os documentos que você está comparando comumente usam um período (.) ou barras invertidas (/) para separar palavras, você pode defini-los como separadores de palavras.

Métodos

Esses são os métodos que você pode usar para configurar as opções de comparação de documentos.

WithContinueOnError

Configure se a automação deve continuar mesmo quando o método gera um erro.

Definição

Namespace: UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Booleano

Especifica se a automação deve continuar mesmo quando o método gera um erro. Este parâmetro só aceita valores booleanos (true, false). O valor padrão é false. Como resultado, se o parâmetro estiver em branco e um erro for gerado, a execução do projeto será interrompida. Se o valor for definido como true, a execução do projeto continua independentemente de qualquer erro.

WithGenerateHtml

Gera um arquivo HTML com as diferenças destacadas identificadas entre os dois documentos ou textos.

Definição

Namespace: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

CaminhoDoArquivo String

O caminho do arquivo HTML que armazena as diferenças identificadas ao comparar os documentos ou textos.

WithGeneratePDF

Gera novos arquivos PDF com as diferenças destacadas para o documento de linha de base e o documento de destino, usado para comparar com o documento de linha de base.

Definição

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

O novo caminho do documento de linha de base, onde você deseja armazenar o arquivo PDF que destacou as diferenças identificadas.

targetPath String

O novo caminho do documento de destino, onde você deseja armazenar o arquivo PDF que destacou as diferenças identificadas.

WithIgnoreIdenticalItems

Se definidas como True, linhas idênticas serão ignoradas durante a comparação.Isso é útil, em especial, ao comparar objetos estáticos, como marcas d'água ou cabeçalhos.

Definição

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 Booleano

Especifica se itens idênticos devem ser ignorados durante a comparação. Por padrão, esse parâmetro é definido como true.

WithIgnoreImagesPageAndPosition

Se definido como verdadeiro, ignora a posição e a página de uma imagem.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIgnoreImagesPageAndPosition(this, bool)

WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)

ignoreImagesPageAndPosition Booleano

Se definido como true, ignora a posição e a página de uma imagem. Por padrão, o valor do parâmetro é false.

WithIgnoreRegexRule

Se definido como True, ignora qualquer regra Regex que você configurou para o parâmetro Rules.Isso permite que você exclua certas partes dos textos ou documentos que você está comparando.

Definição

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

O nome da regra, como você a configurou na lista de Rules, que você deseja ignorar no processo de comparação.

regexPattern String

O regex real que representa o ruleName inserido anteriormente.

usePlaceholder Booleano (Opcional)

Se definido como True ele substitui a parte ignorada de um documento ou texto com um valor de espaço reservado. O valor do espaço reservado é o ruleName.Por padrão, esse parâmetro é definido como true.

WithIgnoreWildcardRule

Se definido como True, ignora qualquer regra de curinga que você configurou para o parâmetro Rules.Isso permite que você exclua certas partes dos textos ou documentos que você está comparando.

Definição

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

O nome da regra, como você a configurou na lista de Rules, que você deseja ignorar no processo de comparação.

wildcardPattern String

O curinga real que representa o ruleName inserido anteriormente.

usePlaceholder Booleano (Opcional)

Se definido como True ele substitui a parte ignorada de um documento ou texto com um valor de espaço reservado. O valor do espaço reservado é o ruleName.Por padrão, esse parâmetro é definido como true.

WithIncludeImages

Inclui imagens no processo de comparação. Se você definir esse método como True, ele também compara imagens, ao verificar a equivalência entre documentos ou textos.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIncludeImages(bool)

WithIncludeImages(
    bool includeImages
)

includeImages Booleano

Se definida como True, a API também compara imagens ao verificar a equivalência entre documentos e textos.

WithWordSeparators

Especifique os caracteres que você deseja definir como separadores de palavras. Os caracteres devem ser armazenados em uma string.

Definição

Namespace: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators String

A string que contém os caracteres que você deseja considerar como separadores de palavras.