DS Server

Javascript: Table.setID Method

Method|Introduced in 28.0

Description

Sets the table's id.

Syntax

<void> Table.setID(<number> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
value

Table id which has to be >= 10 and < 32768.

callback

Optional. Is called when the operation completed.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates Table.setID in a practical document-editing workflow. It sets the table's id.

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.setID(
            1,
            function() {
                console.log("set id completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);