Skip to main content

CreateTable

Creates a new table with a specified number of rows and columns.

Breaking Change

Starting from version 9.4.0, the parameter order has been changed from Api.CreateTable(cols, rows) to Api.CreateTable(rows, cols).

Syntax

expression.CreateTable(rows, cols);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
rowsRequirednumberNumber of rows.
colsRequirednumberNumber of columns.

Returns

ApiTable

Example

Insert a 3x3 table spanning the full page width in a document.

// How do I add a table to a document?

// Build a new table and stretch it to fill the entire line width in a document.

let doc = Api.GetDocument();
let table = Api.CreateTable(3, 3);
doc.Push(table);
table.SetWidth("percent", 100);