Description

Sets a value specifying whether there is a complete frame around the text.

Syntax

<void> InputFormat.setBoxFrame(<Boolean> boxFrame, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
boxFrame	Specifies whether there is a complete frame around 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.setBoxFrame in a practical document-editing workflow. It sets a value specifying whether there is a complete frame around the text.

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

TXTextControl.inputFormat.setBoxFrame(
    true,
    function() {
        console.log("set box frame completed.");
    },
    onTxError
);