XRWatermark.ImageAccessibleRole Property

Specifies the role of an image watermark (XRWatermark) 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#

public XRAccessibleRole ImageAccessibleRole { get; set; }

VB.NET

Public Property ImageAccessibleRole As XRAccessibleRole

Property Value

Type	Description
XRAccessibleRole	The value that defines the XRWatermark 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 ImageAccessibleRole property to specify how screen readers interpret image watermarks in exported PDF documents. You can change the value to Figure or keep the default value of Artifact. An artifact does not appear in the tag tree and is considered external to the content. The ImageAccessibleDescription property is not in effect for artifacts.

If an image watermark conveys meaning and you want to include it to PDF document logical structure, set ImageAccessibleRole to Figure when you create or edit the watermark:

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. XRWatermark.ImageAccessibleRole is set to Figure, and the screen reader treats XRWatermark as a figure in the exported document:

Use the XRWatermark.ImageAccessibleDescription property to specify the description of the resulting element: