New to Telerik Document Processing? Start a free 30-day trial

ListBoxField

Class

List box form field that shows a scrollable set of predefined options; supports single or multi‑selection for capturing one or several values in a PDF form.

Definition

Namespace:Telerik.Windows.Documents.Fixed.Model.InteractiveForms

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

public sealed class ListBoxField : ChoiceField, IStructuralElement

Inheritance: objectFormFieldFormField<VariableContentWidget>ChoiceFieldListBoxField

Implements: IStructuralElement

Inherited Members ChoiceField.OptionsChoiceField.ShouldCommitOnSelectionChangeFormField<VariableContentWidget>.WidgetsFormField.Equals(object)FormField.GetHashCode()FormField.NameFormField.TextPropertiesFormField.ActionsFormField.UserInterfaceNameFormField.MappingNameFormField.IsReadOnlyFormField.IsRequiredFormField.ShouldBeSkippedFormField.StructureTag...

Constructors

ListBoxField(string)

Create a list box field with the specified fieldName.

public ListBoxField(string fieldName)

Parameters:fieldNamestring

The field name.

Properties

AllowMultiSelection

bool

Gets or sets whether the user may select more than one option (enables multi‑value submission when true).

public bool AllowMultiSelection { get; set; }

Property Value:

true to allow multiple selection; false to restrict selection to a single item.

DefaultValue

ChoiceOption[]

Gets or sets the options selected after a form reset (default selection state).

public ChoiceOption[] DefaultValue { get; set; }

Property Value:

An array of default selected options, or null if no default selections are specified.

FieldType

FormFieldType

Gets the form field type identifier (ListBox) used during export and processing.

public override sealed FormFieldType FieldType { get; }

Overrides: FormField.FieldType

TopIndex

int

Gets or sets the zero‑based index of the first option displayed (initial scroll position).

public int TopIndex { get; set; }

Value

ChoiceOption[]

Gets or sets the currently selected options; assign an array to change the selection and refresh widget appearances.

public ChoiceOption[] Value { get; set; }

Property Value:

An array containing all selected options, or null if no options are selected.