GetRow
Returns a table row by its position in the table.
Syntax
expression.GetRow(rowIndex);
expression - A variable that represents a ApiTable class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| rowIndex | Required | number | The row index within the table. |
Returns
Example
Retrieve a specific row from a table by its position in a document.
// How do I access a particular row of a table by its index in a document?
// Use an existing row as a reference point to insert a new row in a document.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("We create a 2x2 table and add a new row, so that it becomes 2x3:");
let tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
let table = Api.CreateTable(2, 2);
table.SetWidth("percent", 100);
table.SetStyle(tableStyle);
table.AddRow(table.GetRow(1).GetCell(0), true);
doc.Push(table);