Resultados de la validación – verifique la accesibilidad web en C#

Aspose.HTML for .NET proporciona el espacio de nombres Aspose.Html.Accessibility, que está destinado a todas las manipulaciones y comprobaciones relacionadas con la accesibilidad web. En este artículo, aprenderá cómo revisar los resultados de las comprobaciones de accesibilidad web para compararlos con el cumplimiento de las WCAG, informar los criterios probados y detallar los problemas específicos encontrados durante la validación.

Puede aprender cómo verificar mediante programación la accesibilidad del sitio web en el artículo Validador de accesibilidad: verificación de accesibilidad del sitio web en C#.

Clase ValidationResult

El espacio de nombres Aspose.Html.Accessibility.Results contiene clases que describen los resultados de la validación de reglas. La clase ValidationResult es la clase principal que contiene resultados para todos los criterios. El objeto ValidationResult incluye una descripción de los resultados de la verificación de un documento y tiene propiedades:

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Details	Returns IList< RuleValidationResult> containing objects of RuleValidationResult with information about validation results.
SaveToString()	Save validation results to string
SaveTo(TextWriter writer)	Saves the validation results in a System.IO.TextWriter object in text format.
SaveTo(TextWriter writer, ValidationResultSaveFormat format)	Saves the validation results to the System.IO.TextWriter object, where the ValidationResultSaveFormat type parameter specifies in what format the text will be saved.

Aquí hay un fragmento de código C# para una verificación de accesibilidad web. Configura un validador con configuraciones específicas, valida un documento HTML y envía los resultados de la validación a la consola:

// Initialize a webAccessibility container
var webAccessibility = new WebAccessibility();

// Create an accessibillity validator with static instance for all rules from repository that match the builder settings
var validator = webAccessibility.CreateValidator(ValidationBuilder.All);

// Prepare a path to a source HTML file
string documentPath = Path.Combine(DataDir, "input.html");

// Initialize an object of the HTMLDocument class
using (var document = new HTMLDocument(documentPath))
{
    // Check the document
    ValidationResult validationResult = validator.Validate(document);

    // Checking for success
    if (!validationResult.Success)
    {
        // Get a list of RuleValidationResult Details
        foreach (var detail in validationResult.Details)
        {
            Console.WriteLine("{0}:{1} = {2}", detail.Rule.Code, detail.Rule.Description, detail.Success);
        }
    }
}

El código genera información sobre problemas de accesibilidad a la consola, lo que le permite identificar y abordar los problemas específicos en su documento HTML.

Clase RuleValidationResult

La clase RuleValidationResult, un resultado de la verificación de reglas, contiene una lista de resultados de métodos ITechniqueResult, que son formas de satisfacer los criterios de éxito.

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Rule	Returns the checked rule. The rule has a type that implements the IRule interface.
Results	Returns a collection of all results, both successful and not. Returns type is IList< ITechniqueResult>.
Errors	Returns a collection of results with Errors. Returns type is IList< ITechniqueResult>.
Warnings	Returns a collection of results with Warnings. Returns type is IList< ITechniqueResult>.

El siguiente código recorre en iteración la lista de objetos RuleValidationResult en la propiedad Details de un objeto validationResult. Cada RuleValidationResult representa el resultado de una verificación de regla de accesibilidad específica durante el proceso de validación:

    // Get a list of RuleValidationResult Details
    foreach (RuleValidationResult result in validationResult.Details)
    {
        Output.WriteLine("{0}:{1} = {2}", result.Rule.Code, result.Rule.Description, result.Success);
    }

Assume the Details contains results for two rules - H37 and H67. The output will be:

H37:Check alt attributes for images = True
H67:Check that all forms have labels = False

ITechniqueResult

El ITechniqueResult es una interfaz pública que contiene información sobre el resultado de la validación.

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Rule	Returns the checked technique with type of IRule.
Error	Returns the object with error. Returns type is IError.

A continuación se muestra un ejemplo de C# del resultado de resultados que no pasaron la prueba de criterios de éxito. Imprimimos en la consola la descripción del código de los criterios, así como todos los detalles de la ejecución de los métodos de estos criterios tanto con éxito como con errores:

1. Cada RuleValidationResult representa un criterio de accesibilidad específico evaluado durante la validación. El código itera a través de los objetos RuleValidationResult contenidos en validationResult.Details.
2. Compruebe si el criterio no tuvo éxito: !criterionResult.Success. Si el criterio falla, el código informa información sobre el criterio fallido.
3. Utilice Console.WriteLine para imprimir el código y la descripción del criterio fallido.
4. Luego, repita los objetos ITechniqueResult. Estos objetos “ITechniqueResult” representan los resultados de reglas individuales para el criterio que informó errores.
5. Para cada resultado de regla, cree un objeto StringBuilder para formatear la información sobre el método, incluido el código del método, el éxito del método y la descripción del método.
6. Imprima información sobre el resultado de cada regla, incluido el código del método, el estado de éxito y la descripción.

// Initialize a webAccessibility container
var webAccessibility = new WebAccessibility();

// Create an accessibillity validator with static instance for all rules from repository that match the builder settings
var validator = webAccessibility.CreateValidator(ValidationBuilder.All);

string documentPath = Path.Combine(DataDir, "input.html");

// Initialize an object of the HTMLDocument class
using (var document = new HTMLDocument(documentPath))
{
    // Check the document
    ValidationResult validationResult = validator.Validate(document);

    // Take a list of rules results
    foreach (var ruleResult in validationResult.Details)
    {
        // List only unsuccessful rule
        if (!ruleResult.Success)
        {
            // Print the code and description of the rule
            Console.WriteLine("{0}:{1}", ruleResult.Rule.Code, ruleResult.Rule.Description);

            // Print the results of all methods
            foreach (ITechniqueResult ruleDetail in ruleResult.Results)
            {
                // Print the code and description of the criterions
                StringBuilder str = new StringBuilder(string.Format("\n{0}: {1} - {2}",
                    ruleDetail.Rule.Code, ruleDetail.Success,
                    ruleDetail.Rule.Description));
                Console.WriteLine(str.ToString());
            }
        }
    }
}

El uso de Aspose.HTML for .NET le permite revisar sistemáticamente los resultados de las comprobaciones de accesibilidad web, informar los criterios probados y detallar los problemas específicos encontrados durante el proceso de validación. Esto es útil para comprender la naturaleza de los problemas de accesibilidad del contenido web y tomar las medidas adecuadas para resolverlos.