Accessibility Validator – Проверка доступности веб-сайта на C#

Создать валидатор – Accessibility Validator

Aspose.HTML for .NET предоставляет пространство имен Aspose.Html.Accessibility, которое предназначено для всех манипуляций и проверок, связанных с веб-доступностью. Класс AccessibilityValidator инициализирует объект, который используется для проверки документа на соответствие критериям успеха. Класс имеет внутренний конструктор, поэтому пользователи не могут напрямую создавать объект класса. Чтобы создать объект, вам необходимо использовать контейнер WebAccessibility.

Чтобы создать Accessibility Validator, инициализируйте объект WebAccessibility следующим образом:

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

Объект webAccessibility имеет следующие основные методы создания валидатора:

Methods	Description
CreateValidator()	An instance of AccessibilityValidator is created according to all the rules with a ValidationBuilder.All object.
CreateValidator(Action\<ValidationBuilder\> builder)	An instance of AccessibilityValidator is created according to all the rules, where the builder is a lambda expression with a list of methods-settings.
CreateValidator(ValidationBuilder builder)	An instance of AccessibilityValidator is created according to all the rules with a ValidationBuilder object.
CreateValidator(IRule rule)	A new AccessibilityValidator instance is created for a specific rule, given the full parameters of the ValidationBuilder.All object.
CreateValidator(IRule rule, Action\<ValidationBuilder\> builder)	Initializes a new instance of the AccessibilityValidator that contains a rule that matches the builder’s settings, where the builder is a lambda expression with a list of methods-settings.
CreateValidator(IRule rule, ValidationBuilder builder)	Initializes a new instance of the AccessibilityValidator that contains a rule that matches the builder’s settings. The builder instance is a static instance of the class ValidationBuilder.
CreateValidator(IList\<IRule\> rules)	An AccessibilityValidator instance is created for a specific rules list.
CreateValidator(IList<IRule> rules, ValidationBuilder builder)	An AccessibilityValidator instance is created for a specific list of rules based on the settings of the ValidationBuilder object.
CreateValidator(IList\<IRule\> rules, Action\<ValidationBuilder\> builder)	An AccessibilityValidator instance is created for a specific list of rules where the builder is a lambda expression with a list of settings ValidationBuilder.

Ниже приведены примеры инициализации объекта AccessibilityValidator:

	// Initialize a webAccessibility container
    var webAccessibility = new WebAccessibility();
    
	// Create an accessibility validator with a static instance for all rules from repository that match the builder settings
    var validator = webAccessibility.CreateValidator(ValidationBuilder.All);
	
    // Get a principle by code
    IRule rule = webAccessibility.Rules.GetPrinciple("1");

    // Create an accessibility validator for one principle, whose rules match the instance settings ValidationBuilder.All
    var validatorRule = webAccessibility.CreateValidator(rule, ValidationBuilder.All);

    // Create an accessibility validator with lambda-expression settings for all rules from repository that match the builder settings inside a project
    var validatorCSS = new AccessibilityValidator(builder => builder.AllLevels().UseCSS());

Класс ValidationBuilder

Класс ValidationBuilder определяет вспомогательный класс, который можно использовать для настройки списка правил, проверяемых валидатором. ValidationBuilder определяет методы и предоставляет конкретные реализации шагов настройки.

Method/Property	Description
ValidationBuilder.None	None of the parameter settings are specified, it is convenient for creating a filter from scratch, when you need to specify which levels, technologies, etc. should be used when checking.
ValidationBuilder.Default	Rules for General technologies, Failures for all levels of criteria will be used when checking the document.
ValidationBuilder.All	The verification will take place at all levels of criteria, for all technologies, including HTML,CSS,Crtipt.
SetHTMLTags(params string[] tags)	The user can specify a list of html-tags to be checked in the document.
AllTechnologies()	All technologies will be applied when checking the document.
UseHTML()	The method indicates that elements of the HTML technology will be checked in the document.
UseCSS()	The method indicates that elements of the CSS technology will be checked in the document.
UseScript()	The method indicates that elements of the ClientSide-Script technology will be checked in the document.
UseFailures()	The method indicates that failures rules will be checked in the document.
UseGeneral()	The method indicates that general rules will be checked in the document.
AllLevels()	The method sets all criteria levels and indicates that the document will be checked according to the criteria of all three levels.
UseLowestLevel()	The method determines that the document must be validated against low-level criteria.
UseMiddleLevel()	The method determines that the document must be validated against mid-level criteria.
UseHighestLevel()	The method determines that the document must be validated against high-level criteria.

Следующий фрагмент кода является примером создания построителя и передачи его в качестве параметра валидатору:

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

    // Create an accessibility validator with object All
    var validator = webAccessibility.CreateValidator(ValidationBuilder.All);

    // Create an accessibility validator with empty filters, and set's html and css technologies, low and middle levels
    var validatorHTML = webAccessibility.CreateValidator(ValidationBuilder.None.UseHTML()
                                                                               .UseCSS()
                                                                               .UseLowestLevel()
                                                                               .UseMiddleLevel());

    // Create an accessibility validator with lambda-expression for all levels and only CSS technologies
    var validatorCSS = webAccessibility.CreateValidator(builder => builder.AllLevels().UseCSS());

    // Create an accessibility validator for all levels of criterion and only img and input elements will be checking
    var validatorIMG = webAccessibility.CreateValidator(builder => builder.AllLevels()
										.AllTechnologies()
                                        .SetHTMLTags("img", "input"));

Как проверить документ на веб-доступность

Для запуска проверки документа необходимо вызвать метод Validate(HTMLDocument document) объекта AccessibilityValidator. Метод проверяет документ на соответствие правилам веб-доступности. Результатом выполнения метода является экземпляр класса ValidationResult.

Вот пример вызова проверки документа:

    // Create an accessibility validator
    AccessibilityValidator validator = webAccessibility.CreateValidator();

    // Initialize HTMLDocument object
    using (var document = new Aspose.Html.HTMLDocument("index.html"))
    {
        // Check the document
        var result = validator.Validate(document);

         // Checking for success
        if (!result.Success)
        {
            foreach (var detail in result.Details)
            {
                // ... do the analysis here...
            }
        }
    }

Класс ValidationResult

Чтобы запустить валидатор, создайте экземпляр объекта валидатора и вызовите метод Validate(HTMLDocument document), передав документ для проверки. Результатом выполнения этого метода является экземпляр класса ValidationResult, содержащий информацию о проверке документа:

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Details	Returns Collection of RuleValidationResult objects containing details about any validation results.

Следующий код напишет в консоль, какое из правил прошло проверку, а какое нет:

	// Initialize an object of the HTMLDocument class
    using (var document = new Aspose.Html.HTMLDocument("index.html"))
    {
        // Check the document
        ValidationResult result = validator.Validate(document);

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

Более полное описание можно найти в статье Результаты проверки – Проверка доступности веб-сайтов на C#.