HTML Accessibility Validator in C#

HTML-Barrierefreiheit mit einer .NET-API validieren

Aspose.HTML for .NET bietet einen AccessibilityValidator zur Prüfung von HTML-Dokumenten anhand von WCAG-Regeln. Validieren Sie eine lokale Datei oder Webseite, ermitteln Sie fehlgeschlagene Prüfungen und betroffene Elemente und exportieren Sie die Ergebnisse als Bericht.

Regelmäßige Validierung hilft Entwicklungsteams, Barrierefreiheitsprobleme vor der Veröffentlichung zu finden und bei jeder Änderung an HTML-Inhalten dieselben Prüfungen anzuwenden.

Ein HTML-Dokument in C# auf Barrierefreiheit prüfen

Erstellen Sie einen Validator mit allen verfügbaren Regeleinstellungen, validieren Sie das Dokument und verarbeiten Sie nur fehlgeschlagene Ergebnisse. Lesen Sie ruleResult.Results, damit jede fehlgeschlagene Technik gemeldet wird, auch wenn ihre separate Errors-Sammlung leer ist.

using System;
using System.IO;
using Aspose.Html;
using Aspose.Html.Accessibility;
using Aspose.Html.Accessibility.Results;

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

WebAccessibility webAccessibility = new WebAccessibility();
AccessibilityValidator validator = webAccessibility.CreateValidator(
    ValidationBuilder.All);

// Validate the HTML document against the configured rules
using HTMLDocument document = new HTMLDocument(documentPath);
ValidationResult validationResult = validator.Validate(document);

foreach (RuleValidationResult ruleResult in validationResult.Details)
{
    if (ruleResult.Success)
    {
        continue;
    }

    Console.WriteLine($"{ruleResult.Rule.Code}: {ruleResult.Rule.Description}");

    // Inspect every technique result, including entries without an error object
    foreach (ITechniqueResult techniqueResult in ruleResult.Results)
    {
        if (techniqueResult.Success)
        {
            continue;
        }

        Console.WriteLine(
            $"  {techniqueResult.Rule.Code}: {techniqueResult.Rule.Description}");

        IError error = techniqueResult.Error;
        if (error == null)
        {
            continue;
        }

        Console.WriteLine($"    {error.ErrorTypeName}: {error.ErrorMessage}");

        if (error.Target?.TargetType == TargetTypes.HTMLElement &&
            error.Target.Item is HTMLElement element)
        {
            Console.WriteLine($"    {element.OuterHTML}");
        }
    }
}

HTML-Barrierefreiheit validieren

1. Erstellen Sie ein WebAccessibility -Objekt, das Zugriff auf die Validatorerstellung und das Repository der Barrierefreiheitsregeln bietet.
2. Rufen Sie CreateValidator(ValidationBuilder.All) auf, um einen Validator für alle Regeln zu erstellen, die den vollständigen Builder-Einstellungen entsprechen.
3. Laden Sie eine Datei oder URL in ein HTMLDocument .
4. Rufen Sie Validate() auf und speichern Sie das zurückgegebene ValidationResult .
5. Durchlaufen Sie Details, wählen Sie die fehlgeschlagenen RuleValidationResult-Objekte aus und untersuchen Sie die fehlgeschlagenen Techniken in Results. Geben Sie Fehlerdetails und das betroffene HTML-Element aus, wenn diese Informationen vorhanden sind.

Barrierefreiheitsprüfungen konfigurieren und verarbeiten

• Vollständige Validierung. ValidationBuilder.All wendet alle verfügbaren Stufen- und Technologieeinstellungen auf die Regeln im Repository an.
• Gefilterte Validierung. Ein Validator kann nach Stufe, Technologie, HTML-Tag, Prinzip, Richtlinie, Kriterium oder einer Regelliste eingeschränkt werden.
• Detaillierte Diagnose. ValidationResult.Details stellt Regelergebnisse bereit, während Technikfehler Meldungen und betroffene Ziele enthalten.
• Lokales und entferntes HTML. HTMLDocument kann vor der Validierung eine HTML-Datei oder die URL einer Webseite laden.
• Exportierbare Ergebnisse. Berichte lassen sich im Code verarbeiten oder für Auswertungen und automatisierte Workflows als TXT, JSON oder XML speichern.
• Manuelle Überprüfung. Automatische Ergebnisse müssen durch Tests der Tastaturbedienung, assistiver Technologien, Inhalte und Benutzerfreundlichkeit ergänzt werden.

Für eine gelegentliche Prüfung ohne Code verwenden Sie den Online Web Accessibility Checker . Nutzen Sie die .NET-API, wenn die Validierung konfiguriert, wiederholt oder in eine Entwicklungspipeline integriert werden soll.

Dokumentation zum Accessibility Validator

Die Anleitung Accessibility Validator – WCAG-Prüfung für Websites erläutert die verfügbaren CreateValidator()-Überladungen und ValidationBuilder-Filter. Unter Fehler und Warnungen bei der Barrierefreiheitsprüfung erfahren Sie, wie fehlgeschlagene Techniken und Zielelemente verarbeitet werden. Ergebnisse der Barrierefreiheitsprüfung speichern beschreibt den Export von Berichten als TXT, JSON oder XML.

Aspose.HTML for .NET installieren

Installieren Sie Aspose.HTML for .NET aus NuGet mit der .NET CLI:

dotnet add package Aspose.HTML

Alternativ können Sie die Benutzeroberfläche des NuGet-Paket-Managers verwenden oder Install-Package Aspose.HTML in der Paket-Manager-Konsole ausführen. Einzelheiten zur Einrichtung finden Sie in der Installationsanleitung . Mit einer temporären Lizenz können Sie die API ohne Einschränkungen der Evaluierung testen.

Häufige Fragen zum HTML Accessibility Validator

1. Wie validiere ich die HTML-Barrierefreiheit in C#?

Laden Sie die HTML-Datei oder URL mit HTMLDocument, erstellen Sie über WebAccessibility einen AccessibilityValidator und rufen Sie Validate() auf. Das zurückgegebene ValidationResult enthält den Status und detaillierte Ergebnisse für die ausgewerteten Regeln.

2. Kann ein automatischer Validator WCAG-Konformität garantieren?

Nein. Die automatische Validierung kann maschinell prüfbare Fehler erkennen, viele Anforderungen hängen jedoch vom Kontext und menschlicher Beurteilung ab. Zusätzliche Tests der Tastaturbedienung, assistiver Technologien und der inhaltlichen Bedeutung bleiben erforderlich.

3. Kann der Validator lokale HTML-Dateien und Webseiten prüfen?

Ja. HTMLDocument kann eine lokale Datei oder URL laden. Die Validierung einer entfernten Seite hängt vom Netzwerkzugriff und davon ab, ob das Dokument die für die ausgewählten Prüfungen benötigten Stylesheets, Skripte und weiteren Ressourcen abrufen kann.

4. Kann ich nur ausgewählte WCAG-Regeln oder Stufen validieren?

Ja. Filtern Sie mit ValidationBuilder nach Stufe oder Technologie oder erstellen Sie den Validator mit einem Prinzip, einer Richtlinie, einem Kriterium oder einer expliziten Regelliste. Dies ist sinnvoll, wenn eine Pipeline statt des gesamten Repositorys eine gezielte Richtlinie benötigt.

5. Können Ergebnisse der Barrierefreiheitsprüfung gespeichert werden?

Ja. Verwenden Sie SaveToString() für eine Textdarstellung oder SaveTo() mit ValidationResultSaveFormat, um TXT, JSON oder XML zu schreiben. Strukturierte Ausgaben können archiviert oder von Berichts- und Qualitätssicherungsprozessen verarbeitet werden.