Class ListBoxField

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.

Inheritance
System.Object
FormField
FormField<VariableContentWidget>
ChoiceField
ListBoxField
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Fixed.Model.InteractiveForms
Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public sealed class ListBoxField : ChoiceField, IInstanceIdOwner, IStructuralElement, IWidgetCreator<VariableContentWidget>

Constructors

ListBoxField(String)

Create a list box field with the specified fieldName.

Declaration
public ListBoxField(string fieldName)
Parameters
System.String fieldName

The field name.

Properties

AllowMultiSelection

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

Declaration
public bool AllowMultiSelection { get; set; }
Property Value
System.Boolean

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

DefaultValue

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

Declaration
public ChoiceOption[] DefaultValue { get; set; }
Property Value
ChoiceOption[]

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

FieldType

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

Declaration
public override sealed FormFieldType FieldType { get; }
Property Value
FormFieldType

Overrides

TopIndex

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

Declaration
public int TopIndex { get; set; }
Property Value
System.Int32

Value

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

Declaration
public ChoiceOption[] Value { get; set; }
Property Value
ChoiceOption[]

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