Validierungsergebnisse – Webzugänglichkeit prüfen
Aspose.HTML for .NET bietet den Aspose.Html.Accessibility Namespace, der für alle Manipulationen und Überprüfungen im Zusammenhang mit der Barrierefreiheit im Web gedacht ist. In diesem Artikel erfahren Sie, wie Sie die Ergebnisse von Prüfungen der Barrierefreiheit auf Einhaltung der WCAG überprüfen, die getesteten Kriterien melden und spezifische Probleme, die während der Validierung aufgetreten sind, detailliert beschreiben können.
In dem Artikel Accessibility Validator – Überprüfung der Zugänglichkeit von Websites in C# erfahren Sie, wie Sie die Zugänglichkeit von Websites programmatisch überprüfen können.
ValidationResult Klasse
Der Aspose.Html.Accessibility.Results Namespace enthält Klassen, die die Ergebnisse der Regelvalidierung beschreiben. Die Klasse ValidationResult ist die Hauptklasse, die Ergebnisse für alle Kriterien enthält. Das ValidationResult-Objekt enthält eine Beschreibung der Ergebnisse der Prüfung eines Dokuments und verfügt über Eigenschaften:
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. |
Hier ist ein C#-Codefragment für eine Überprüfung der Barrierefreiheit im Web. Er richtet einen Validator mit spezifischen Einstellungen ein, validiert ein HTML-Dokument und gibt die Validierungsergebnisse auf der Konsole aus:
1// Validate HTML against WCAG rules using C#
2
3// Initialize a webAccessibility container
4WebAccessibility webAccessibility = new WebAccessibility();
5
6// Create an accessibillity validator with static instance for all rules from repository that match the builder settings
7AccessibilityValidator validator = webAccessibility.CreateValidator(ValidationBuilder.All);
8
9// Prepare a path to a source HTML file
10string documentPath = Path.Combine(DataDir, "input.html");
11
12// Initialize an object of the HTMLDocument class
13using (HTMLDocument document = new HTMLDocument(documentPath))
14{
15 // Check the document
16 ValidationResult validationResult = validator.Validate(document);
17
18 // Checking for success
19 if (!validationResult.Success)
20 {
21 // Get a list of RuleValidationResult Details
22 foreach (RuleValidationResult detail in validationResult.Details)
23 {
24 Console.WriteLine("{0}:{1} = {2}", detail.Rule.Code, detail.Rule.Description, detail.Success);
25 }
26 }
27}
Der Code gibt Informationen über Zugänglichkeitsprobleme auf der Konsole aus, so dass Sie die spezifischen Probleme in Ihrem HTML-Dokument identifizieren und beheben können.
RuleValidationResult-Klasse
Die Klasse RuleValidationResult – ein Ergebnis der Regelprüfung – enthält eine Liste von Methodenergebnissen ITechniqueResult, die Wege zur Erfüllung der Erfolgskriterien darstellen.
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>. |
Der folgende Code durchläuft die Liste der RuleValidationResult
-Objekte in der Eigenschaft Details
eines ValidationResult
-Objekts. Jedes RuleValidationResult
stellt das Ergebnis einer bestimmten Zugänglichkeitsregelprüfung während des Validierungsprozesses dar:
1 // Get a list of RuleValidationResult Details
2 foreach (RuleValidationResult result in validationResult.Details)
3 {
4 Console.WriteLine("{0}:{1} = {2}", result.Rule.Code, result.Rule.Description, result.Success);
5 }
Assume the Details
contains results for two rules – H37 and H67. The output will be:
1H37:Check alt attributes for images = True
2H67:Check that all forms have labels = False
ITechniqueResult
Die ITechniqueResult ist eine öffentliche Schnittstelle, die Informationen über das Ergebnis der Validierung enthält.
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. |
Im Folgenden finden Sie ein C#-Beispiel für die Ausgabe von Ergebnissen, die den Test der Erfolgskriterien nicht bestanden haben. Wir drucken auf der Konsole Code Beschreibung der Kriterien, sowie alle Details der Ausführung der Methoden dieser Kriterien sowohl erfolgreich und mit Fehlern:
- Jedes
RuleValidationResult
stellt ein bestimmtes Zugänglichkeitskriterium dar, das während der Validierung bewertet wird. Der Code iteriert durch die in “ValidationResult.Details” enthaltenenRuleValidationResult
-Objekte. - Prüfen, ob das Kriterium nicht erfolgreich war –
!criterionResult.Success
. Wenn das Kriterium fehlschlägt, meldet der Code Informationen über das fehlgeschlagene Kriterium. - Verwenden Sie
Console.WriteLine
, um den Code und die Beschreibung des fehlgeschlagenen Kriteriums zu drucken. - Dann durchlaufen Sie die
ITechniqueResult
-Objekte. Diese “ITechniqueResult”-Objekte stellen die Ergebnisse der einzelnen Regeln für das Kriterium dar, das Fehler gemeldet hat. - Erstellen Sie für jedes Regelergebnis ein `StringBuilder’-Objekt, um Informationen über die Methode zu formatieren, einschließlich des Methodencodes, des Methodenerfolgs und der Methodenbeschreibung.
- Druckt Informationen über das Ergebnis jeder Regel, einschließlich des Methodencodes, des Erfolgsstatus und der Beschreibung.
1// Validate HTML accessibility using C# and print all failed WCAG rule with their descriptions
2
3// Initialize a webAccessibility container
4WebAccessibility webAccessibility = new WebAccessibility();
5
6// Create an accessibillity validator with static instance for all rules from repository that match the builder settings
7AccessibilityValidator validator = webAccessibility.CreateValidator(ValidationBuilder.All);
8
9string documentPath = Path.Combine(DataDir, "input.html");
10
11// Initialize an object of the HTMLDocument class
12using (HTMLDocument document = new HTMLDocument(documentPath))
13{
14 // Check the document
15 ValidationResult validationResult = validator.Validate(document);
16
17 // Take a list of rules results
18 foreach (RuleValidationResult ruleResult in validationResult.Details)
19 {
20 // List only unsuccessful rule
21 if (!ruleResult.Success)
22 {
23 // Print the code and description of the rule
24 Console.WriteLine("{0}:{1}", ruleResult.Rule.Code, ruleResult.Rule.Description);
25
26 // Print the results of all methods
27 foreach (ITechniqueResult ruleDetail in ruleResult.Results)
28 {
29 // Print the code and description of the criterions
30 StringBuilder str = new StringBuilder(string.Format("\n{0}: {1} - {2}",
31 ruleDetail.Rule.Code, ruleDetail.Success,
32 ruleDetail.Rule.Description));
33 Console.WriteLine(str.ToString());
34 }
35 }
36 }
37}
Mit Aspose.HTML for .NET können Sie die Ergebnisse von Barrierefreiheitsprüfungen systematisch überprüfen, die getesteten Kriterien melden und spezifische Probleme, die während des Validierungsprozesses aufgetreten sind, detailliert beschreiben. Dies ist nützlich, um die Art Ihrer Probleme mit der Barrierefreiheit von Webinhalten zu verstehen und geeignete Maßnahmen zu deren Lösung zu ergreifen.
Siehe auch
- Im Kapitel Zugänglichkeitsprüfung erfahren Sie, wie Sie die Zugänglichkeit einer Website auf die Einhaltung der WCAG überprüfen oder nur bestimmte Kriterien erfüllen können, indem Sie die Klassen und Methoden der Namespaces Aspose.Html.Accessibility und Aspose.Html.Accessibility.Results verwenden.
- Schauen Sie sich den Artikel Farbkontrast in C# prüfen an, wenn Sie erfahren möchten, wie Sie den Kontrast Ihrer Webinhalte richtig an die WCAG-Standards, die weltweite Autorität für Barrierefreiheit im Web, anpassen. Sie erfahren, wie Sie die Zugänglichkeit von Farbkontrasten mit C# testen und Ihre Webinhalte für alle Benutzer leicht lesbar machen können.
- Im Artikel Accessibility Validator lernen Sie die Klasse AccessibilityValidator kennen, die zum Testen von Zugänglichkeitsregeln wie Prinzipien, Richtlinien und Kriterien verwendet werden kann.
- In dem Artikel Web-Zugänglichkeitsregeln erfahren Sie, wie Sie die Klasse AccessibilityRules, eine Sammlung von WCAG-2-Anforderungen, Erfolgskriterien und Techniken, für Prüfungen der Barrierefreiheit im Web verwenden können.
- Der Artikel
Fehler und Warnungen beschreibt die Klassen und Schnittstellen, mit deren Hilfe Informationen über Fehler und Warnungen während des Testens der Barrierefreiheit von Websites gesammelt werden können. Er konzentriert sich auf die Fehlerkriterien und Methoden, die Fehler melden, und bietet ein C#-Beispiel zum Abrufen von Fehlern bei der Barrierefreiheit nach dem Testen eines HTML-Dokuments.
Aspose.HTML bietet einen kostenlosen Online- Web-Zugänglichkeits-Checker. Dieses Tool scannt Webseiten, prüft sie auf WCAG-Konformität, identifiziert Probleme und schlägt Verbesserungen vor. Sie erhalten sofortige Einblicke in die Konformität Ihrer Website und können so den Umfang der notwendigen Korrekturen und die Lücke zwischen dem aktuellen Zustand Ihrer Website oder Ihres HTML-Dokuments und den WCAG-Anforderungen bestimmen.