---
title: "PdfCheckBoxField"
canonical_url: "https://www.nutrient.io/api/csharp/editors/pdf/formfields/pdf-check-box-field/"
md_url: "https://www.nutrient.io/api/csharp/editors/pdf/formfields/pdf-check-box-field.md"
last_updated: "2026-10-08T08:55:57.709Z"
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.

```csharp

using Nutrient;

```

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

The SDK creates this class through factory methods or other SDK objects.

## Properties

### BackgroundColor

```csharp

public Color? BackgroundColor { get; set; }

```

The background color of the check box.

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

### BorderColor

```csharp

public Color? BorderColor { get; set; }

```

The border color of the check box.

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

### IsChecked

```csharp

public bool IsChecked { get; set; }

```

Whether the check box is currently checked.

**Type:** `bool`

## Methods

### GetOnStateName

```csharp

public string GetOnStateName()

```

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

**Returns:** `string` - The on-state name.

## Resource management

```csharp

public void Dispose()

```

`PdfCheckBoxField` implements `IDisposable`. Call `Dispose()` or use a C# `using` declaration to release its native handle right away. If you don't, the handle is released when the object is garbage collected.

---

## Related pages

- [Formfields](/api/csharp/editors/pdf/formfields.md)
- [Pdf Combo Box Field](/api/csharp/editors/pdf/formfields/pdf-combo-box-field.md)
- [Pdf Form Field Collection](/api/csharp/editors/pdf/formfields/pdf-form-field-collection.md)
- [Pdf Form Field](/api/csharp/editors/pdf/formfields/pdf-form-field.md)
- [Pdf List Box Field](/api/csharp/editors/pdf/formfields/pdf-list-box-field.md)
- [Pdf Push Button Field](/api/csharp/editors/pdf/formfields/pdf-push-button-field.md)
- [Pdf Radio Button Field](/api/csharp/editors/pdf/formfields/pdf-radio-button-field.md)
- [Pdf Signature Field](/api/csharp/editors/pdf/formfields/pdf-signature-field.md)
- [Pdf Text Field](/api/csharp/editors/pdf/formfields/pdf-text-field.md)