New to Telerik Document Processing? Start a free 30-day trial
ListBoxField
Updated on Jun 3, 2026
The ListBoxField class corresponds to the FormFieldType.ListBox enum value and represents a list with choices that can be selected. It represents a form field that displays a scrollable list of options. Users can select one or more choices from the list.
Properties
The ListBoxField class provides the following properties:
| Property | Description |
|---|---|
Value | Gets or sets an array of selected choices. Each choice is a ChoiceOption with Value and UserInterfaceValue properties. UserInterfaceValue is optional. When null, Value is used to display the choice in the UI. |
DefaultValue | Gets or sets the default selected choices used when the AcroForm is reset to its default values. |
Widgets | A collection of Widget annotations representing the field on the PDF pages. Widgets are created using AddWidget() and can be removed using Remove(). Implements IEnumerable. |
Options | A ChoiceOptionCollection containing all available choices for this field. Modify through the indexer, Add(), RemoveAt(), and Clear(). Each ChoiceOption instance can be added only once. |
ShouldCommitOnSelectionChange | Indicates whether to commit the selected value on selection change. |
TopIndex | Gets or sets the index of the choice that is displayed at the top of the list box viewport rectangle. |
Example 1: Create a ListBoxField and Add It to a Page
C#
ListBoxField listBoxField = new ListBoxField("SampleListBox");
listBoxField.Options.Add(new ChoiceOption("First Value"));
listBoxField.Options.Add(new ChoiceOption("Second Value"));
listBoxField.Options.Add(new ChoiceOption("Third Value"));
listBoxField.Value = new ChoiceOption[] { listBoxField.Options[1] };
VariableContentWidget widget = listBoxField.Widgets.AddWidget();
widget.Rect = new Rect(100, 100, 200, 200);
widget.RecalculateContent();
document.AcroForm.FormFields.Add(listBoxField);
document.Pages[0].Annotations.Add(widget);