SetSummary

Sets the summary description (alternative text summary) for the table.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax

expression.SetSummary(summary);

expression - A variable that represents a ApiListObject class.

Parameters

Name	Required/Optional	Data type	Default	Description
summary	Required	string		The alternative text summary for the table.

Returns

This method doesn't return any data.

Example

Assign a plain-text description to a table in a spreadsheet.

// How do I add a summary or description to a table in a spreadsheet?

// Store a short note about the table's contents so the purpose of the data is clear in a spreadsheet.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Product");
worksheet.GetRange("B1").SetValue("Price");
worksheet.GetRange("A2").SetValue("Apples");
worksheet.GetRange("B2").SetValue(100);
worksheet.GetRange("A3").SetValue("Oranges");
worksheet.GetRange("B3").SetValue(150);
let table = worksheet.AddListObject("xlSrcRange", "A1:B3");
table.SetSummary("Monthly product sales data");

worksheet.GetRange("D1").SetValue("Summary:");
worksheet.GetRange("E1").SetValue(table.GetSummary());