Click or drag to resize
Pdftools logo

ListBox Properties

The ListBox type exposes the following members.

Properties
 NameDescription
Public propertyAllowMultiSelect

Allow multiple items to be selected

Public propertyChosenItems

The selected choice items

Adding to this list results in an error:

  • IllegalState
    • if the list has already been closed
    • if the choice field is marked a read-only
    • if this list is not empty and the list box field is not marked as multi-select
    • if the choice field has widgets
  • UnsupportedOperation if the document is read-only
  • IllegalArgument
    • if the given choice item is
    • if the given choice item has already been closed
    • if the given choice item is already present in this list
    • if the given choice item does not belong to the list box field's choice items

Removing items or clearing the list results in an IllegalState error if the form field is marked as read-only, or if it has widgets.

Public propertyDisplayName

User interface name

The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
(Inherited from FieldNode)
Public propertyDoNotExport

Tells whether this field is exported


(Inherited from Field)
Public propertyExportName

The name used when exporting


(Inherited from FieldNode)
Public propertyItems

The list of choice items

Adding or removing items or clearing the list is not supported.
(Inherited from ChoiceField)
Public propertyReadOnly

Flags this field as read-only


(Inherited from Field)
Public propertyRequired

Flags this field as mandatory


(Inherited from Field)
Public propertyWidgets

This form field's widget annotations


(Inherited from Field)
Top
See Also