XRShape.AccessibleRole Property

Specifies the control’s accessible role in the exported PDF document. This value is used by assistive technologies.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v25.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[Browsable(true)]
public override XRAccessibleRole AccessibleRole { get; set; }

VB.NET

<Browsable(True)>
Public Overrides Property AccessibleRole As XRAccessibleRole

Property Value

Type	Description
XRAccessibleRole	The value that defines the XRShape role.

Available values:

Show 13 items

Name	Description
Default	Applies default semantic meaning based on element type.
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.
Decorative	Applies “decorative” semantic meaning to an XRShape, XRPictureBox, XRZipCode, or XRBarCode.
Figure	Applies “figure” semantic meaning to an image watermark (XRWatermark).
Paragraph	Applies “paragraph” semantic meaning to a text watermark (XRWatermark).

Remarks

Use the AccessibleRole property to specify how screen readers treat the XRShape control in exported PDF documents. You can change the value to Decorative or keep the default value of Figure.

A decorative element is called an artifact and is not part of PDF document logical structure. An artifact does not appear in the tag tree and is considered external to the content.

Note

Do not exclude elements that carry meaning, use this tag only for decorative elements.

Before you export your report, set the PdfExportOptions.PdfUACompatibility property to PdfUA1 to make the document PDF/UA compatible.

The image below shows the result. XRShape.AccessibleRole is set to Decorative, and the screen reader treats XRShape as an artifact in the exported document:

The AccessibleDescription property is not in effect for artifacts.