Class ListBoxField

Represents a list box form field that displays a scrollable list of options, allowing users to select one or multiple items depending on the configuration.

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)

Initializes a new instance of ListBoxField class.

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

The field name.

Properties

AllowMultiSelection

Gets or sets a value indicating whether users can select multiple items simultaneously from the list box.

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 an array of choice options that will be selected by default when the form is reset to its initial 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 field type.

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

Overrides

TopIndex

Gets or sets the index of the first item to be visible when displaying the ListBox.

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

Value

Gets or sets an array of currently selected choice options in the list box.

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

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