---
title: "PdfCheckBoxField"
canonical_url: "https://www.nutrient.io/api/python/editors/pdf/formfields/pdf-check-box-field/"
md_url: "https://www.nutrient.io/api/python/editors/pdf/formfields/pdf-check-box-field.md"
last_updated: "2026-06-09T10:32:42.528Z"
description: "Represents a check box form field in a PDF document. Check boxes toggle between two states: checked and unchecked."
---

Represents a check box form field in a PDF document. Check boxes toggle between two states: checked and unchecked.

```python

from nutrient_sdk import PdfCheckBoxField

```

**Inherits from:** [`PdfFormField`](/api/python/editors/pdf/formfields/pdf-form-field/)

## Construction

`PdfCheckBoxField` cannot be instantiated directly. Obtain instances through static factory methods or via other SDK classes.

## Properties

### background_color

```python

@property
def background_color(self) -> Color

@background_color.setter
def background_color(self, value: Color) -> None

```

The background color of the check box.

**Type:** [`Color`](/api/python/types/color/)

---

### border_color

```python

@property
def border_color(self) -> Color

@border_color.setter
def border_color(self, value: Color) -> None

```

The border color of the check box.

**Type:** [`Color`](/api/python/types/color/)

---

### is_checked

```python

@property
def is_checked(self) -> bool

@is_checked.setter
def is_checked(self, value: bool) -> None

```

Whether the check box is currently checked.

**Type:** `bool`

---

### on_state_name

```python

@property
def on_state_name(self) -> str

```

Gets the "on" state name for this check box. This is the value used when the check box is checked (often "Yes" or "On").

**Type:** `str`

*Read-only property.*

---

## Inherited members

From [`PdfFormField`](../pdf-form-field/): `child`, `child_count`, `default_value`, `field_type`, `full_name`, `is_read_only`, `is_required`, `is_terminal`, `name`, `parent`, `value`, `widget`, `widget_count`, `remove_child_at`

---

## Related pages

- [All public classes import directly from the top-level package:](/api/python/editors/pdf/formfields.md)
- [Pdf Combo Box Field](/api/python/editors/pdf/formfields/pdf-combo-box-field.md)
- [Pdf Form Field Collection](/api/python/editors/pdf/formfields/pdf-form-field-collection.md)
- [Pdf Form Field](/api/python/editors/pdf/formfields/pdf-form-field.md)
- [Pdf List Box Field](/api/python/editors/pdf/formfields/pdf-list-box-field.md)
- [Pdf Push Button Field](/api/python/editors/pdf/formfields/pdf-push-button-field.md)
- [Pdf Radio Button Field](/api/python/editors/pdf/formfields/pdf-radio-button-field.md)
- [Pdf Signature Field](/api/python/editors/pdf/formfields/pdf-signature-field.md)
- [Pdf Text Field](/api/python/editors/pdf/formfields/pdf-text-field.md)