Available for: UI for ASP.NET MVC | UI for ASP.NET AJAX | UI for Blazor | UI for WPF | UI for WinForms | UI for Silverlight | UI for Xamarin | UI for WinUI | UI for ASP.NET Core | UI for .NET MAUI

New to Telerik Document Processing? Download free 30-day trial

CheckBoxField Class

This article describes the following topics:


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


CheckBoxField provides the following properties:

  • IsChecked: Gets or sets Boolean 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, which represent the field on the PDF pages. The widgets can be added and removed from the collection using the collection's AddWidget() and Remove() methods respectively. As the widget collection implements the IEnumerable interface, the available widget instances can be iterated.

  • 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

CheckBoxField checkBoxField = new CheckBoxField("SampleCheckBox"); 
checkBoxField.IsChecked = true; 
TwoStatesButtonWidget widget = checkBoxField.Widgets.AddWidget(); 
widget.Rect = new Rect(100, 100, 20, 20); 

See Also

In this article