Description

Gets a value indicating which control characters are shown permanently on the screen.

Syntax

<void> TXTextControl.getPermanentControlChars(<RequestPermanentControlCharsCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives which control characters are shown permanently on the screen.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TXTextControl.getPermanentControlChars in a practical document-editing workflow. It gets a value indicating which control characters are shown permanently on the screen.

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

TXTextControl.getPermanentControlChars(
    function(controlChars) {
        if (!controlChars) {
            console.warn("No permanent control char was returned.");
            return;
        }
        
        console.log("get permanent control chars result:", controlChars);
    },
    onTxError
);