# CheckFormField Object

> The CheckFormField object represents a checkbox in a document. The checkbox can be checked or unchecked through the end-user.

- **Product:** DS Server
- **Section:** Reference
- **Kind:** Object
- **Introduced:** 28.0
- **Path:** DS Server > Reference > JavaScript API > CheckFormField Object
- **952 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/llms-full.txt

---

### Description

The CheckFormField object represents a checkbox in a document. The checkbox can be checked or unchecked through the end-user.

### Syntax

```javascript
CheckFormField
```

### Examples

The following example demonstrates `CheckFormField` in a practical document-editing workflow. The CheckFormField object represents a checkbox in a document. The checkbox can be checked or unchecked through the end-user.

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

function inspectCheckFormField(checkFormField) {
    checkFormField.getChecked(
        function(result) {
            if (result) {
                console.log("get checked is available.");
            } else {
                console.warn("get checked is not available in the current document state.");
            }
        },
        onTxError
    );
}
```

---

## In This Section

- [Javascript: CheckFormField.getChecked Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/getchecked-method/llms-full.txt): Gets a value indicating whether the checkbox is in the checked state.
- [Javascript: CheckFormField.getCheckedCharacter Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/getcheckedcharacter-method/llms-full.txt): Gets the character which is used to display the checkbox in the checked state.
- [Javascript: CheckFormField.getUncheckedCharacter Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/getuncheckedcharacter-method/llms-full.txt): Gets the character which is used to display the checkbox in the unchecked state.
- [Javascript: CheckFormField.setChecked Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/setchecked-method/llms-full.txt): Sets a value indicating whether the checkbox is in the checked state.
- [Javascript: CheckFormField.setCheckedCharacter Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/setcheckedcharacter-method/llms-full.txt): Sets the character which is used to display the checkbox in the checked state.
- [Javascript: CheckFormField.setUncheckedCharacter Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/setuncheckedcharacter-method/llms-full.txt): Sets the character which is used to display the checkbox in the unchecked state.

---

## Nearby

- **Previous:** [Javascript: ChartEventArgs.chartFrame Property](https://docs.textcontrol.com/ds-server/reference/javascript/charteventargs/chartframe-property/llms-full.txt)
- **Next:** [Javascript: CheckFormField.getChecked Method](https://docs.textcontrol.com/ds-server/reference/javascript/checkformfield/getchecked-method/llms-full.txt)