XRControl.AccessibleDescription Property
Bindable. Gets or sets the description of a control used by assistive technologies.
Namespace: DevExpress.XtraReports.UI
Assembly: DevExpress.XtraReports.v24.2.dll
NuGet Package: DevExpress.Reporting.Core
Declaration
[DefaultValue("")]
[SRCategory(ReportStringId.CatData)]
[XRLocalizable(true)]
public virtual string AccessibleDescription { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| String | String.Empty | A string that is the textual description of a control. |
Remarks
Use the AccessibleDescription property to specify text that the screen reader reads. If the AccessibleDescription value is String.Empty, the screen reader reads the Text property value. This property is used when you export a report to PDF format to create the structure of PDF files that conform to PDF/A-1a, PDF/A-2a, PDF/A-3a, or PDF/UA standard.
The following controls use the AccessibleDescription property to create tags that screen readers can read (vocalize):
- Web Document Viewer in Accessibility Mode (the viewer’s
AccessibilityCompliantproperty istrue). - WinForms Document Viewer (Accessibility Mode is enabled out-of-the-box).
- WPF Document Preview in Accessibility Mode (the ClearAutomationEventsHelper.IsEnabled property is
false)
The AccessibleDescription property is bindable, which means that it can be bound to a field in a report’s data source. Refer to the following topic for more details: Bind Report Controls to Data Using Expression Bindings.
The following table shows the controls for which you can specify the AccessibleDescription property.
| Report Control | Accessible Description |
|---|---|
| Band and its descendants | |
| SubreportBase and its descendants | |
| XRBarCode |  |
| XRCharacterComb | |
| XRChart and descendants | |
| XRCheckBox | |
| XRCrossBandControl and descendants | |
| XRCrossTab | |
| XRCrossTabCell | |
| XRGauge | |
| XRLabel | |
| XRLine | |
| XRPdfContent | |
| XRPdfSignature | |
| XRPivotGrid | |
| XRPageBreak | |
| XRPageInfo | |
| XRPanel | |
| XRPictureBox | |
| XRRichTextBase and descendants | |
| XRSparkline | |
| XRTable | |
| XRTableCell | |
| XRTableOfContents | |
| XRTableRow | |
| WinControlContainer | |
| XRZipCode | |