DS Server

Javascript: CheckFormField.setUncheckedCharacter Method

Method|Introduced in 28.0

Description

Sets the character which is used to display the checkbox in the unchecked state.

Syntax

<void> CheckFormField.setUncheckedCharacter(<String> character, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
character

The character which is used to display the checkbox in the unchecked state.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates CheckFormField.setUncheckedCharacter in a practical document-editing workflow. It sets the character which is used to display the checkbox in the unchecked state.

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

function configureUncheckedCharacter(checkFormField) {
    checkFormField.setUncheckedCharacter(
        "✓",
        function() {
            console.log("set unchecked character completed.");
        },
        onTxError
    );
}