C# Web 可访问性 API
在 C# 中按照 WCAG 规则检查 HTML,查找可访问性问题并导出验证结果。
使用 .NET API 检查 Web 可访问性
Aspose.HTML for .NET 提供用于检查 HTML 文件和网页可访问性的 API。使用 Aspose.Html.Accessibility 命名空间可以执行完整检查,也可以针对图像替代文本缺失、颜色对比度不足等特定问题选择规则。
可访问的 HTML 可帮助使用屏幕阅读器、键盘导航、放大工具及其他辅助技术的用户操作 Web 内容。定期检查可访问性有助于开发团队及早发现问题,并在内容变化后继续保持页面符合 WCAG 要求。
选择 Web 可访问性工作流
| 开发任务 | 推荐工作流 |
|---|---|
| 执行完整的可访问性检查并分析检测到的问题 | HTML 可访问性验证器 |
| 按照选定的 WCAG 规则检查 HTML 文档 | WCAG 可访问性规则 |
检查缺失或使用不当的图像 alt 属性 | 图像 alt 属性检查器 |
| 测试最低和增强文本对比度标准 | 颜色对比度检查器 |
按照 WCAG A 级和 AA 级验证 HTML
此示例选择 WCAG A 级和 AA 级标准,并启用适用于 HTML 和 CSS 技术的规则。代码验证文档并导出检测到的错误和警告。
配置 Web 可访问性验证的 C# 代码
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();
// Select WCAG Level A and AA checks for HTML and CSS technologies
ValidationBuilder validationPolicy = ValidationBuilder.None
.UseHTML()
.UseCSS()
.UseLowestLevel()
.UseMiddleLevel();
AccessibilityValidator validator = webAccessibility.CreateValidator(
validationPolicy);
// Validate the document and export detected issues
using HTMLDocument document = new HTMLDocument(documentPath);
ValidationResult validationResult = validator.Validate(document);
Console.WriteLine($"Validation passed: {validationResult.Success}");
if (!validationResult.Success)
{
Console.WriteLine(validationResult.SaveToString());
}
构建可访问性验证工作流
- 选择验证范围,包括所有可用检查、指定级别和技术、WCAG 层次结构对象或明确的规则列表。
- 创建 WebAccessibility 对象并配置 AccessibilityValidator 。
- 将本地文件或网页 URL 加载到 HTMLDocument 中。
- 调用
Validate()并处理返回的 ValidationResult 。 - 记录自动检测结果,修正源文件,并完成所需的手动可访问性测试。
Web 可访问性 API 功能
- 可配置验证。 使用规则库中的全部规则,或按一致性级别、技术、HTML 标签、原则、指南、标准或规则代码筛选检查。
- 专项检查。 为替代文本、标签、文档结构、颜色对比度及其他支持的要求构建专项工作流。
- 详细结果。 查看规则和技术的结果、错误类型、消息,以及与问题相关的 HTML 或 CSS 目标。
- 导出报告。 将验证结果保存为文本、JSON 或 XML,用于审查、日志和自动质量流程。
- 应用程序集成。 在内容处理、CMS 验证、测试或 CI/CD 管道中重复执行相同策略。
- 明确的限制。 自动检查可以辅助可访问性工作,但没有人工评估时不能证明完全符合 WCAG。
如果只需执行一次无代码检查,请使用 在线 Web Accessibility Checker 。
Web 可访问性文档
请先阅读 网络无障碍 概述。有关配置,请参阅 辅助功能验证器 ;有关规则库层次结构,请参阅 Web 可访问性规则 ;有关报告格式,请参阅 保存可访问性验证结果 。
安装 Aspose.HTML for .NET
使用 .NET CLI 从 NuGet 安装 Aspose.HTML for .NET :
dotnet add package Aspose.HTML
您也可以使用 NuGet 包管理器界面,或在包管理器控制台中运行 Install-Package Aspose.HTML。有关配置详情,请参阅
安装指南
;如需不受评估版限制地测试 API,请申请
临时许可证
。
Web 可访问性 API 常见问题
1. Aspose.HTML for .NET 可以自动执行哪些可访问性检查?
API 可以按照支持的可访问性规则评估 HTML,包括替代文本、标签、结构、CSS 和颜色对比度检查。具体范围取决于选择的规则、技术和一致性级别。
2. 应检查所有规则还是只选择部分规则?
常规审查应使用广泛验证。如果项目有明确策略或需要快速检查特定组件,可选择级别、技术、标签、标准或单独的规则代码。有限的规则集不能视为完整审计。
3. 可以在 CI/CD 中运行 Web 可访问性检查吗?
可以。在测试或内容构建期间运行验证器,导出结果,并按项目条件决定管道应发出警告还是失败。手动可访问性测试仍是发布流程中的独立环节。
探索 Aspose.HTML for .NET 的更多功能
继续查看用于编辑、创建、生成和转换 HTML 内容的工具与 API 指南。