DS Server

Javascript: TableRow.getIsHeader Method

Method|Introduced in 28.0

Description

Gets a value specifying whether the table row is part of the table's header.

Syntax

<void> TableRow.getIsHeader(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives whether the table row is part of the table's header.

errorCallback

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

Examples

The following example demonstrates TableRow.getIsHeader in a practical document-editing workflow. It gets a value specifying whether the table row is part of the table's header.

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

function inspectIsHeader(tableRow) {
    tableRow.getIsHeader(
        function(result) {
            if (result) {
                console.log("get is header is available.");
            } else {
                console.warn("get is header is not available in the current document state.");
            }
        },
        onTxError
    );
}