Javascript: Table.split Method

Description

Splits a table below or above the current input position. If the table does not contain the current input position it cannot be split. The getCanSplit method can be used to determine if a table can be split or not. If a table is split above the first row a new line is inserted above the table and if a table is split below the last row a new line is inserted below the table. This is useful to insert text above or below a nested table that immediately starts and/or ends at the beginning or the end of the cell in which it is nested.

Syntax

<void> Table.split(<TableAddPosition> tableAddPosition, [<RequestBooleanCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Examples

The following example demonstrates Table.split in a practical document-editing workflow. It splits a table below or above the current input position. If the table does not contain the current input position it cannot be split. The getCanSplit method can be used to determine if a table can be split or not. If a table is split above the first row a new line is inserted above the table and if a table is split below the last row a new line is inserted below the table. This is useful to insert text above or below a nested table that immediately starts and/or ends at the beginning or the end of the cell in which it is nested.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const tables = mainText.tables;
    tables.getItem(function(table) {
        if (!table) {
            console.warn("No table is available at the current input position.");
            return;
        }
    
        table.split(
            TXTextControl.TableAddPosition.After,
            function(result) {
                if (result) {
                    console.log("split is available.");
                } else {
                    console.warn("split is not available in the current document state.");
                }
            },
            onTxError
        );
    }, onTxError);
}, onTxError);