Back to Devexpress

XRWatermark.TextAccessibleRole Property

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xrwatermark-eba93333.md

latest3.8 KB
Original Source

XRWatermark.TextAccessibleRole Property

Specifies the role of a text 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

csharp
public XRAccessibleRole TextAccessibleRole { get; set; }
vb
Public Property TextAccessibleRole As XRAccessibleRole

Property Value

TypeDescription
XRAccessibleRole

The value that defines the XRWatermark role.

|

Available values:

Show 13 items

NameDescription
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 TextAccessibleRole property to specify how screen readers interpret text watermarks in exported PDF documents. You can change the value to Paragraph or keep the default value of Artifact. An artifact does not appear in the tag tree and is considered external to the content. The TextAccessibleDescription property is not in effect for artifacts.

If a text watermark conveys meaning and you want to include it to PDF document logical structure, set TextAccessibleRole to Paragraph 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.TextAccessibleRole is set to Paragraph, and the screen reader treats XRWatermark as a paragraph in the exported document:

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

See Also

XRWatermark Class

XRWatermark Members

DevExpress.XtraReports.UI Namespace