Description

Gets a value specifying whether all frame lines, including all inner frame lines, are set for the selected text.

Syntax

<void> InputFormat.getAllFrameLines(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives whether all frame lines, including all inner frame lines, are set for the selected text.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates InputFormat.getAllFrameLines in a practical document-editing workflow. It gets a value specifying whether all frame lines, including all inner frame lines, are set for the selected text.

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

TXTextControl.inputFormat.getAllFrameLines(
    function(result) {
        if (result) {
            console.log("get all frame lines is available.");
        } else {
            console.warn("get all frame lines is not available in the current document state.");
        }
    },
    onTxError
);