alternativeText property

ShapeBase.alternativeText property

Defines alternative text to be displayed instead of a graphic.

get alternativeText(): string

Remarks

The default value is an empty string.

Examples

Shows how to use a shape’s alternative text.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
let shape = builder.insertShape(aw.Drawing.ShapeType.Cube, 150, 150);
shape.name = "MyCube";

shape.alternativeText = "Alt text for MyCube.";

// We can access the alternative text of a shape by right-clicking it, and then via "Format AutoShape" -> "Alt Text".
doc.save(base.artifactsDir + "Shape.AltText.docx");

// Save the document to HTML, and then delete the linked image that belongs to our shape.
// The browser that is reading our HTML will display the alt text in place of the missing image.
doc.save(base.artifactsDir + "Shape.AltText.html");
expect(fs.existsSync(base.artifactsDir + "Shape.AltText.001.png")).toEqual(true);
fs.rmSync(base.artifactsDir + "Shape.AltText.001.png");

See Also

ShapeBase.allowOverlap property ShapeBase.anchorLocked property