XRAccessibleRole Enum

Lists values that define UI element roles in the exported PDF document. These roles are used by assistive technologies.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v23.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public enum XRAccessibleRole

VB.NET

Public Enum XRAccessibleRole

Members

Name	Description
Default	Applies no semantic meaning to the UI element.
Heading1	Applies “level one heading” meaning to an XRLabel.
Heading2	Applies “level two heading” meaning to an XRLabel.
Heading3	Applies “level three heading” meaning to an XRLabel.
Heading4	Applies “level four heading” meaning to an XRLabel.
Heading5	Applies “level five heading” meaning to an XRLabel.
Heading6	Applies “level six heading” meaning to an XRLabel.
Table	Applies “table” meaning to an XRTable.
TableHeaderRow	Applies “header row” meaning to an XRTableRow.
TableHeaderCell	Applies “header cell” meaning to an XRTableCell.

Related API Members

The following properties accept/return XRAccessibleRole values:

• XRLabel.AccessibleRole
• XRTable.AccessibleRole
• XRTableRow.AccessibleRole

Remarks

If the element’s role is Default, the element has no role. Assistive software commonly treats such elements as HTML <div> tags. Change the element’s role to one of the values listed below to help the screen reader correctly identify the element’s purpose in the exported PDF document.

The following list describes the available elements in a report and their structure roles:

Heading

Use XRLabel.AccessibleRole to define XRLabel as a heading.

Table

Use XRTable.AccessibleRole to define XRTable as a table.

Table Header Row

Use XRTableRow.AccessibleRole to define XRTableRow as a table header row.

Header Cell

Use XRLabel.AccessibleRole to define XRTableCell as a header cell.

The following image illustrates the difference between default and specified roles: