Description

Sets a value specifying whether there is a frame line at the top of the text.

Syntax

<void> InputFormat.setTopFrameLine(<Boolean> topFrameLine, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
topFrameLine	Specifies whether there is a frame line at the top of the text.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates InputFormat.setTopFrameLine in a practical document-editing workflow. It sets a value specifying whether there is a frame line at the top of the text.

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

TXTextControl.inputFormat.setTopFrameLine(
    true,
    function() {
        console.log("set top frame line completed.");
    },
    onTxError
);