new AcroFormListBox()
- Source:
Extends
Members
color :string|rgba
- Source:
- Inherited From:
- Default Value:
- 'black'
The color of the text
Type:
- string | rgba
combo :boolean
- Source:
- Inherited From:
- Default Value:
- false
If set, the field is a combo box; if clear, the field is a list box.
Type:
- boolean
commitOnSelChange :boolean
- Source:
- Inherited From:
- Default Value:
- false
(PDF 1.5) If set, the new value shall be committed as soon as a selection is made (commonly with the pointing device). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or “commits” the data choice and triggers any actions associated with the entry or changing of this data. If this flag is on, then processing does not wait for leaving the field action to occur, but immediately proceeds to the third step. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field.
Type:
- boolean
defaultValue :any
- Source:
- Inherited From:
- Default Value:
- null
(Optional; inheritable) The default value to which the field reverts when a reset-form action is executed (see 12.7.5.3, “Reset-Form Action”). The format of this value is the same as that of value.
Type:
- any
doNotSpellCheck :boolean
- Source:
- Inherited From:
- Default Value:
- false
(PDF 1.4) If set, text entered in the field shall not be spellchecked. This flag shall not be used unless the Combo and Edit flags are both set.
Type:
- boolean
edit :boolean
- Source:
- Inherited From:
- Default Value:
- false
If set, the combo box shall include an editable text box as well as a drop-down list; if clear, it shall include only a drop-down list. This flag shall be used only if the Combo flag is set.
Type:
- boolean
fieldName :string
- Source:
- Inherited From:
- Default Value:
- null
(Optional) The partial field name (see 12.7.3.2, “Field Names”).
Type:
- string
fontName :string
- Source:
- Inherited From:
- Default Value:
- 'helvetica'
The fontName of the font to be used.
Type:
- string
fontSize :number
- Source:
- Inherited From:
- Default Value:
- 0 (for auto)
The fontSize of the font to be used.
Type:
- number
fontStyle :string
- Source:
- Inherited From:
- Default Value:
- 'normal'
The fontStyle of the font to be used.
Type:
- string
(readonly) hasAnnotation :boolean
- Source:
- Inherited From:
Check if field has annotations
Type:
- boolean
(readonly) hasAppearanceStream :boolean
- Source:
- Inherited From:
true if field has an appearanceStream
Type:
- boolean
height :number
- Source:
- Inherited From:
- Default Value:
- null
The height of the field.
Type:
- number
maxFontSize :number
- Source:
- Inherited From:
- Default Value:
- 0 (for auto)
The maximum fontSize of the font to be used.
Type:
- number
multiSelect :boolean
- Source:
- Inherited From:
- Default Value:
- false
(PDF 1.4) If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected
Type:
- boolean
noExport :boolean
- Source:
- Inherited From:
- Default Value:
- false
If set, the field shall not be exported by a submit-form action (see 12.7.5.2, “Submit-Form Action”)
Type:
- boolean
page :number
- Source:
- Inherited From:
The page on which the AcroFormField is placed
Type:
- number
readOnly :boolean
- Source:
- Inherited From:
- Default Value:
- false
If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.
Type:
- boolean
required :boolean
- Source:
- Inherited From:
- Default Value:
- false
If set, the field shall have a value at the time it is exported by a submitform action (see 12.7.5.2, “Submit-Form Action”).
Type:
- boolean
showWhenPrinted :boolean
- Source:
- Inherited From:
- Default Value:
- true
(PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of wether is is displayed on the screen. NOTE 2 This can be useful for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.
Type:
- boolean
sort :boolean
- Source:
- Inherited From:
- Default Value:
- false
If set, the field’s option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers. Conforming readers shall display the options in the order in which they occur in the Opt array (see Table 231).
Type:
- boolean
textAlign :string
- Source:
- Inherited From:
- Default Value:
- 'left'
(Optional; inheritable) A code specifying the form of quadding (justification) that shall be used in displaying the text: 'left', 'center', 'right'
Type:
- string
topIndex :number
- Source:
- Inherited From:
- Default Value:
- 0
(Optional) For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list). Default value: 0.
Type:
- number
value :any
- Source:
- Inherited From:
- Default Value:
- null
(Optional; inheritable) The field’s value, whose format varies depending on the field type. See the descriptions of individual field types for further information.
Type:
- any
width :number
- Source:
- Inherited From:
- Default Value:
- null
The width of the field.
Type:
- number
x :number
- Source:
- Inherited From:
- Default Value:
- null
The x-position of the field.
Type:
- number
y :number
- Source:
- Inherited From:
- Default Value:
- null
The y-position of the field.
Type:
- number
Methods
addOption(value)
- Source:
- Inherited From:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
getOptions() → {array}
- Source:
- Inherited From:
Returns:
array of Options
- Type
- array
removeOption(value, allEntries)
- Source:
- Inherited From:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | |
allEntries |
boolean | (default: false) |
setOptions(value)
- Source:
- Inherited From:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
array |