Description

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

Syntax

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

Parameters

Parameter	Description
character	The character which is used to display the checkbox in the checked 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.setCheckedCharacter in a practical document-editing workflow. It sets the character which is used to display the checkbox in the checked state.

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

function configureCheckedCharacter(checkFormField) {
    checkFormField.setCheckedCharacter(
        "✓",
        function() {
            console.log("set checked character completed.");
        },
        onTxError
    );
}