Description

Sets a value specifying whether text is underlined at the current input position.

Syntax

<void> InputFormat.setUnderline(<Boolean> underline, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
underline	Specifies whether text is underlined at the current input position.
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.setUnderline in a practical document-editing workflow. It sets a value specifying whether text is underlined at the current input position.

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

TXTextControl.inputFormat.setUnderline(
    true,
    function() {
        console.log("set underline completed.");
    },
    onTxError
);