ListBox Class

A list box field

Inheritance Hierarchy

Namespace: PdfTools.FourHeights.PdfToolbox.Pdf.Forms
Assembly: PdfTools.FourHeights.PdfToolbox (in PdfTools.FourHeights.PdfToolbox.dll) Version: 1.0.0

Syntax

public class ListBox : ChoiceField

The ListBox type exposes the following members.

Properties

	Name	Description
	AllowMultiSelect	Allow multiple items to be selected
	ChosenItems	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.
	DisplayName	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)
	DoNotExport	Tells whether this field is exported (Inherited from Field)
	ExportName	The name used when exporting (Inherited from FieldNode)
	Items	The list of choice items Adding or removing items or clearing the list is not supported. (Inherited from ChoiceField)
	ReadOnly	Flags this field as read-only (Inherited from Field)
	Required	Flags this field as mandatory (Inherited from Field)
	Widgets	This form field's widget annotations (Inherited from Field)

Methods

	Name	Description
	AddNewItem	Creates a new choice item. The item is automatically added to the choice field's Items. (Inherited from ChoiceField)
	AddNewWidget	Create a new widget and add to the form field This method creates a widget for the form field. The widget is automatically added to the field's widgets, but not to any page. This method does not work for radio button form fields; Use AddNewWidget(Rectangle). (Inherited from Field)
	Create	Create a list box form field The returned form field object is not yet used, but it is associated with the given target document.
	Equals	(Inherited from NativeObject)
	GetHashCode	(Inherited from NativeObject)