DS Server

Javascript: TableCollection.getGridLines Method

Method|Introduced in 28.0

Description

Gets a value indicating whether table's gridlines are shown or not.

Syntax

<void> TableCollection.getGridLines(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives whether table's gridlines are shown or not.

errorCallback

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

Examples

The following example demonstrates TableCollection.getGridLines in a practical document-editing workflow. It gets a value indicating whether table's gridlines are shown or not.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const tables = mainText.tables;
    tables.getGridLines(
        function(result) {
            if (result) {
                console.log("get grid lines is available.");
            } else {
                console.warn("get grid lines is not available in the current document state.");
            }
        },
        onTxError
    );
}, onTxError);