SetTableDescription
Sets the table description.
Syntax
expression.SetTableDescription(descr);
expression - A variable that represents an ApiTable class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| descr | Required | string | The table description to be set. |
Returns
boolean
Example
Set the description of a table in a PDF.
// Give a table an accessible description in a PDF.
// Create a table, set its description, and display it in the first cell in a PDF.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const table = Api.CreateTable(3, 3);
table.SetTableDescription('Sales data for Q1 2025');
const paragraph = Api.CreateParagraph();
paragraph.AddText('Table description: ' + table.GetTableDescription());
table.GetCell(0, 0).GetContent().Push(paragraph);
page.AddObject(table);