1. Home
  2. API
  3. Broadside.Forms
  4. PdfAcroForm
  5. Methods
  6. AddListBox(String, PdfPage, PdfRectangle, IEnumerable, PdfFieldOptions?)

AddListBox(String, PdfPage, PdfRectangle, IEnumerable, PdfFieldOptions?) Method

Definition

Namespace Broadside.Forms
Assembly Broadside.dll
View source

Creates a list box with one widget on page, nothing selected.

public PdfListBoxField AddListBox(string name, PdfPage page, PdfRectangle rectangle, IEnumerable<PdfChoiceOption> choices, PdfFieldOptions? options = null)

Parameters

name
String

The field's fully qualified name, as for AddTextField(String, PdfPage, PdfRectangle, PdfFieldOptions?).

page
PdfPage

The page the widget is on, a page of this form's document.

rectangle
PdfRectangle

The widget's rectangle, in default user space.

choices
IEnumerable<PdfChoiceOption>

The options, in the order shown.

options
PdfFieldOptions

The field's flags (Sort, MultiSelect, CommitOnSelChange), text appearance and widget colours; null for the defaults.

Returns

PdfListBoxField
The new field; select options with SetValue(String?) or SetSelectedIndices(IEnumerable<Int32>).

Remarks

ISO 32000-2 §12.7.5.4, Tables 233 and 234. A choice field without the Combo flag; MultiSelect needs PDF 1.4. Otherwise as AddComboBox(String, PdfPage, PdfRectangle, IEnumerable<PdfChoiceOption>, PdfFieldOptions?) describes.