DS Server

Javascript: TableCell.setName Method

Method|Introduced in 28.0

Description

Sets the cell's name. Each table cell can have a name, which can be used to store any string data associated with the cell.

Syntax

<void> TableCell.setName(<string> name, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
name

The cell's name.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates TableCell.setName in a practical document-editing workflow. It sets the cell's name. Each table cell can have a name, which can be used to store any string data associated with the cell.

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

function configureName(tableCell) {
    tableCell.setName(
        "QuarterlyReport",
        function() {
            console.log("set name completed.");
        },
        onTxError
    );
}