DS Server

Javascript: InputFormat.getUnderlineStyle Method

Method|Introduced in 28.0

Description

Gets a value specifying the style at the current input position.

Syntax

<void> InputFormat.getUnderlineStyle(<RequestFontUnderlineStyleCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the style at the current input position.

errorCallback

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

Examples

The following example demonstrates InputFormat.getUnderlineStyle in a practical document-editing workflow. It gets a value specifying the style at the current input position.

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

TXTextControl.inputFormat.getUnderlineStyle(
    function(result) {
        if (!result) {
            console.warn("No font underline style was returned.");
            return;
        }
        
        console.log("get underline style result:", result);
    },
    onTxError
);