Javascript: CheckFormField.getCheckedCharacter Method

Description

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

Syntax

<void> CheckFormField.getCheckedCharacter(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the character which is used to display the checkbox in the checked state.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates CheckFormField.getCheckedCharacter in a practical document-editing workflow. It gets 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 inspectCheckedCharacter(checkFormField) {
    checkFormField.getCheckedCharacter(
        function(result) {
            console.log("get checked character result:", result);
        },
        onTxError
    );
}