DrawingObject.AltText Property

Gets or sets the alternative text for a shape.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

string AltText { get; set; }

VB.NET

Property AltText As String

Property Value

Type	Description
String	The descriptive text associated with a shape.

Remarks

The AltText property contains all alternative text for a shape (a combination of Title and Description property values).

If you assign text to the AltText property, it is copied to the Description property and the Title property is set to null.

The example below shows how to add Alt Text to a shape:

C#

Document document = wordProcessor.Document;
// Create a callout and specify its alternative text.
Shape shape = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.AccentLineCallout1);
shape.AltText = "A callout with an accent bar and a straight callout line.";

VB.NET

Dim document As Document = wordProcessor.Document
' Create a callout and specify its alternative text.
Dim shape As Shape = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.AccentLineCallout1)
shape.AltText = "A callout with an accent bar and a straight callout line."