DS Server

Javascript: TXTextControl.setIsSpellCheckingEnabled Method

Method|Introduced in 28.0

Description

Sets a value indicating whether spell checking is active or not.

Syntax

<void> TXTextControl.setIsSpellCheckingEnabled(<boolean> enable, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
enable

Specifies whether spell checking is active or not.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates TXTextControl.setIsSpellCheckingEnabled in a practical document-editing workflow. It sets a value indicating whether spell checking is active or not.

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

TXTextControl.setIsSpellCheckingEnabled(
    true,
    function() {
        console.log("set is spell checking enabled completed.");
    },
    onTxError
);