Clase de TestingOptions.CompareDocuments

Utiliza esta clase para configurar opciones para comparar documentos con la API VerifyDocumentsEquivalence.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

Sintaxis

public class TestingOptions : CompareDocuments

Constructores

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments

Inicializa una nueva instancia de la clase TestingOptions.CompareDocuments .

Propiedades

AdditionalOutputFilePath Cadena

Ruta al archivo de salida adicional. Debe establecerse si OutputDiffType es PDF.

ContinueOnError Booleano

Especifica si la automatización debe continuar incluso cuando el método arroja un error. Este parámetro solo admite valores booleanos (true, false). El valor predeterminado es alse. Como resultado, si el parámetro está en blanco y se produce un error, la ejecución del proyecto se detiene. Si el valor se establece en true, la ejecución del proyecto continúa independientemente de cualquier error.

IgnoreIdenticalItems Booleano

Si se establece en True, se ignoran elementos idénticos durante la comparación.Esto es útil al comparar objetos estáticos, como marcas de agua o encabezados. Por defecto, este parámetro está establecido como true.

IgnoreImagesLocation Booleano

Si se establece en true, ignora la ubicación de una imagen en los documentos comparados.Por defecto, este parámetro está establecido como false.

IncludeImages Booleano

Si se establece como verdadero, el proceso de comparación también incluye imágenes. Por defecto, este parámetro está establecido como true.

OutputDiffType DocumentOutputDiffType

El tipo que deseas utilizar para devolver las diferencias entre los documentos.

OutputFilePath Cadena

La ruta de salida del documento base.

Reglas Lista<ComparisonRule>

Lista de reglas que se aplicarán. Pueden ser de tipo RegexRule o WildcardRule.

WordSeparators Cadena

Los objetos, como cadenas, que deseas considerar como separadores de palabras en el proceso de comparación. Por ejemplo, si los documentos que comparas utilizan comúnmente un punto (.) o barras invertidas (/) para separar palabras, puedes definirlos como separadores de palabras.

Métodos

Estos son los métodos que puedes utilizar para configurar las opciones de comparación de documentos.

WithContinueOnError

Configura si la automatización debe continuar incluso cuando el método arroja un error.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Booleano

Especifica si la automatización debe continuar incluso cuando el método arroja un error. Este parámetro solo admite valores booleanos (true, false). El valor predeterminado es false. Como resultado, si el parámetro está en blanco y se produce un error, la ejecución del proyecto se detiene. Si el valor se establece en true, la ejecución del proyecto continúa independientemente de cualquier error.

WithGenerateHtml

Genera un archivo HTML con las diferencias resaltadas identificadas entre los dos documentos o textos.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

Ruta del archivo Cadena

La ruta del archivo HTML que almacena las diferencias identificadas al comparar los documentos o textos.

WithGeneratePDF

Genera nuevos archivos PDF con las diferencias resaltadas tanto para el documento de referencia como para el documento de destino, utilizados para comparar con el documento de referencia.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath Cadena

La nueva ruta del documento de referencia, donde deseas almacenar el archivo PDF que resaltó las diferencias identificadas.

targetPath Cadena

La nueva ruta del documento de destino, donde deseas almacenar el archivo PDF que resaltó las diferencias identificadas.

WithIgnoreIdenticalItems

Si se establece en True, las líneas idénticas se ignoran durante la comparación.Esto es útil, en particular, al comparar objetos estáticos, como marcas de agua o encabezados.

Definición

Espacio de nombres: 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 si elementos idénticos deben ignorarse durante la comparación. De forma predeterminada, este parámetro está establecido en true.

WithIgnoreImagesPageAndPosition

Si se establece en true, ignora la posición y la página de una imagen.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

WithIgnoreImagesPageAndPosition(this, bool)

WithIgnoreImagesPageAndPosition(
    bool ignoreImagesPageAndPosition = false
)

ignoreImagesPageAndPosition Booleano

Si se establece en true, ignora la posición y la página de una imagen. De forma predeterminada, el valor del parámetro es false.

WithIgnoreRegexRule

Si se establece en True, ignora cualquier regla Regex que configuraste para el parámetro Rules.Esto te permite excluir ciertas partes de los textos o documentos que estás comparando.

Definición

Espacio de nombres: 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 Cadena

El nombre de la regla, tal como la configuraste en la lista de Rules, que deseas ignorar en el proceso de comparación.

regexPattern Cadena

La expresión regex real que representa el ruleName introducido anteriormente.

usePlaceholder Booleano (opcional)

Si se establece en True, reemplaza la parte ignorada de un documento o texto con un valor de marcador de posición.El valor del marcador de posición es el ruleName. De forma predeterminada, este parámetro está establecido en true.

WithIgnoreWildcardRule

Si se establece en True, ignora cualquier regla de comodín que configuraste para el parámetro Rules.Esto te permite excluir ciertas partes de los textos o documentos que estás comparando.

Definición

Espacio de nombres: 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 Cadena

El nombre de la regla, tal como la configuraste en la lista de Rules, que deseas ignorar en el proceso de comparación.

wildcardPattern Cadena

El comodín real que representa el ruleName introducido anteriormente.

usePlaceholder Booleano (opcional)

Si se establece en True, reemplaza la parte ignorada de un documento o texto con un valor de marcador de posición.El valor del marcador de posición es el ruleName. De forma predeterminada, este parámetro está establecido en true.

WithIncludeImages

Incluye imágenes en el proceso de comparación. Si estableces este método en True, también compara imágenes, al verificar la equivalencia entre documentos o textos.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

WithIncludeImages(bool)

WithIncludeImages(
    bool includeImages
)

includeImages Booleano

Si se establece en True, la API también compara imágenes al verificar la equivalencia entre documentos y textos.

WithWordSeparators

Especifica los caracteres que deseas definir como separadores de palabras. Los caracteres deben almacenarse en una cadena.

Definición

Espacio de nombres: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators Cadena

La cadena que contiene los caracteres que deseas considerar como separadores de palabras.