Back to Devexpress

Accessibility for Web Document Viewer

xtrareports-404932-web-reporting-common-features-accessibility-document-viewer-web-accessibility.md

latest9.8 KB
Original Source

Accessibility for Web Document Viewer

  • Jul 03, 2025
  • 6 minutes to read

Accessibility features help users who have a physical disability, such as restricted mobility or limited vision, to use information technology products. This article describes accessibility areas that we take into consideration when developing the DevExpress Web Document Viewer.

The DevExpress Web Document Viewer takes into account accessibility guidelines such as WCAG 2.2 (Level AA), Section 508, and EN 301 549 standards. To learn more about how the DevExpress Web Document Viewer satisfies these requirements, refer to the following DevExpress Accessibility Conformance Report (ACR):

Download: Web Document Viewer ACR (Aug 2024)

Accessibility Features Overview

Accessibility RequirementSupport Level
Keyboard Navigation Support
Screen Reader Support
Contrast Color Theme
Lighthouse Accessibility Validation
Axe Accessibility Validation
WAVE Accessibility Validation

- all component features meet the requirement

- component features partially meet the requirement

Accessibility Mode

Set the AccessibilityCompliant option to true to enable Accessibility mode. The table below explains how to set this option for different platforms.

ASP.NET Web Forms and MVCASP.NET CoreAngularReact
Set the ASPxWebDocumentViewer.AccessibilityCompliant property to trueCall the WebDocumentViewerBuilder.AccessibilityCompliant method with the true parameter.Set the control’s accessibilityCompliant property to true.Set the control’s accessibilityCompliant property to true.

The following code snippet enables accessibility mode :

aspx
<dx:ASPxWebDocumentViewer ID="ASPxWebDocumentViewer1" runat="server"
    AccessibilityCompliant="true">
</dx:ASPxWebDocumentViewer>
cshtml
@Html.DevExpress().WebDocumentViewer(settings =>
{
    settings.Name = "WebDocumentViewer1";
    settings.AccessibilityCompliant = true;
}).Bind("TestReport").GetHtml()
cshtml
@{
    var viewerRender = Html.DevExpress().WebDocumentViewer("DocumentViewer")
        .Height("1000px")
        .AccessibilityCompliant(true)
        .Bind("TestReport");
    @viewerRender.RenderHtml()
}
html
<dx-report-viewer 
    [reportUrl]="reportUrl" 
    height="800px" 
    [accessibilityCompliant]="true">
    <dxrv-request-options [invokeAction]="invokeAction" [host]="hostUrl"></dxrv-request-options>
</dx-report-viewer>
typescript
function App() {

  return (
      <ReportViewer reportUrl="TestReport">
        <RequestOptions host="http://localhost:5000" invokeAction="/DXXRDV" accessibilityCompliant={true}/>
      </ReportViewer>        
  )
}

export default App

Screen Reader Support

The Document Viewer for Web component supports screen readers and complies to WAI-ARIA standards. Exceptions are listed in the Web Document Viewer ACR (Aug 2024).

For screen readers, you can specify custom text that the screen reader can vocalize instead of an element’s default content. Refer to the AccessibleDescription topic for more details.

Contrast Color Theme

You can change style options (colors, font size, family) to improve readability.

In Accessibility mode, font sizes are measured in rem units. All fonts in the Document Viewer are relative to the font size specified in the document root. You can specify the base font size in the html selector or adjust browser font settings to improve readability.

You can apply the “Contrast” theme to the Document Viewer to make it accessible for visually impaired users. You can also change the color scheme for any theme to meet accessibility guidelines related to color contrast.

The code snippet that specifies the root font size and applies the Contrast theme is shown in the Accessibility Mode section.

For more information on color schemes, refer to the following help topics:

ASP.NET Web FormsASP.NET MVCASP.NET Core
Customize the Document Viewer Color Scheme (ASP.NET WebForms)Customize the Document Viewer Color Scheme (ASP.NET MVC)Customize the Document Viewer Color Scheme (ASP.NET Core)

Keyboard Navigation

In accessibility mode, all interactive and navigation controls contained in the following UI elements are accessible by keyboard and display a keyboard-focus indicator:

  • Toolbar
  • Document page
  • Drill-trough breadcrumbs
  • Tab Panel
  • Tabs in the Tab Panel: Parameters, Export Options, Search, Document Map, and custom panels.

YouTube video

Toolbar

ActionShortcut Key
Move focus from the browser to the Document Viewer ToolbarTab
Move focus to the next item in toolbarRight Arrow
Move focus to the previous item in toolbarLeft Arrow
Activate the selected toolbar editor
Note : When you select the Search button, the Search Tab is opened and focusedEnter or Space
Open and display a drop-down list or menuAlt + Down Arrow
Move between editor values in the activated Pager or Zoom combo boxUp Arrow, Down Arrow
Deactivate the combo boxEsc

Document Page

ActionShortcut Key
Move focus to the Document Area (or to Drill-Through breadcrumbs if displayed)Tab
Enter Document Read modeEnter or Space
Move between bricks on a pageRight Arrow, Left Arrow
Exit Document Read modeTab, Shift + Tab

Tab Panel

ActionShortcut Key
Move focus to the Tab panelTab
Move between tabs in the Tab panelUp Arrow and Down Arrow
Open or close the selected tabEnter or Space

Preview Parameters Tab

ActionShortcut Key
Move to the next control inside the tabTab
Move to the previous control inside the tabShift + Tab
Activate the parameter editorEnter or Space
Move to the browser toolbar from the last editorTab
Move to the Tab panel from the first editorShift + Tab

Export Options Tab

ActionShortcut Key
Move to the next control inside the tabTab
Move to the previous control inside the tabShift + Tab
Move to the first control inside the tabHome
Move to the last control inside the tabEnd
Open the selected sectionEnter or Space
Toggle the checkbox stateEnter or Space
Display a list of values in a combo boxAlt + Down
Deactivate the editor and move to the next editorTab
Move to the browser toolbar from the last editorTab
Move to the Tab panel from the first editorShift + Tab

Search Tab

ActionShortcut Key
Move to the next control inside the tabTab
Move to the previous control inside the tabShift + Tab
Move to the browser toolbar from the last editorTab
Move to the Tab panel from the first editorShift + Tab
Search a document for the specified textEnter
Navigate to the next search results when the list with the result is selectedDown Arrow
Navigate to the previous search results when the list with the result is selectedUp Arrow
Highlight the matching text in the document
Note : The Search tab remains focused.Enter
Exit the Search result listShift + Tab
Move to the browser toolbar from the last editorTab
Move to the Tab panel from the first editorShift + Tab

Document Map Tab

ActionShortcut Key
Expand the document’s bookmark treeAlt + Right Arrow
Collapse the document’s bookmark treeAlt + Left Arrow
Open the document page that contains the bookmark and highlight the bookmark
Note : The Document Map tab remains focusedEnter
Move to the browser toolbar from the last editorTab
Exit the Document Map Tab and move to the Tab PanelShift + Tab

Common Keyboard Shortcuts

The following keyboard shortcuts work even when Accessibility Mode is disabled: Keyboard Shortcuts in Report Designer and Document Viewer for Web.