CheckBoxField Class

Updated on May 11, 2026

This article describes the following topics:

• CheckBoxField Class Overview

• CheckBoxField Class Properties

Overview

This class corresponds to FormFieldType.CheckBox enum value and represents a box that can be checked or unchecked.

Properties

CheckBoxField provides the following properties:

Property	Description
IsChecked	Gets or sets a value indicating whether the field is checked.
IsCheckedByDefault	Gets or sets the default field value used when the AcroForm is reset to its default values.
Widgets	The collection of Widget annotations representing the field on the PDF pages. Widgets can be added using AddWidget() and removed using Remove(). Implements IEnumerable.
ExportValue	Gets or sets the value of the field when exporting the interactive form. The default export value is "Yes".

Example 1: Create a CheckBoxField and add it to a page

C#

CheckBoxField checkBoxField = new CheckBoxField("SampleCheckBox");
checkBoxField.IsChecked = true;

TwoStatesButtonWidget widget = checkBoxField.Widgets.AddWidget();
widget.Rect = new Rect(100, 100, 20, 20);
widget.RecalculateContent();

document.AcroForm.FormFields.Add(checkBoxField);
document.Pages[0].Annotations.Add(widget);

See Also

• Form Field
• Widgets
• RadioButtonField Class
• Create Interactive Forms SDK example
• Modifying Forms SDK example