XFA Specification
Chapter 15, Template Specification
Template Reference
469
The choiceList element
A user interface element that describes a widget presenting a list of options. The list of options is specified
by one or more sibling items elements.
<choiceList
Properties:
commitOn="select
|
exit"
id="xml-id"
open="userControl
|
onEntry
|
always
|
multiSelect"
textEntry="0
|
1"
use="cdata"
usehref="cdata"
>
<border>
[0..1]
<extras>
[0..1]
<margin>
[0..1]
</choiceList>
The choiceList element is used within the following other elements:
proto ui
The border property
A
box model
element that describes the border surrounding an object.
For more information see "The
The commitOn property
This property specifies when the user's selections are propagated to the XFA Data DOM.
select
When the user clicks choice-list data with the mouse, the selected data value is written to the XFA
Data DOM. Alternatively, if the user presses the enter key after previously using other keyboard
sequences to shift focus to a particular entry in the choice list, the selected data is written to the
XFA Data DOM.
Note:
Having a choice list commit data as soon as selections are made may be important in forms
that contain non-XFA interactive features, such as Acrobat annotations or hypertext links. People
filling out such forms may erroneously believe that selecting an item from a choice list followed by
clicking a non-XFA interactive feature is the same as exiting the check list. In fact, the check list
remains the field in focus.
exit
The selected data is not written to the XFA Data DOM until the field loses focus. This is the
recommended setting for choice lists that support multiple selections (
open="multiSelect"
).
The extras property
An enclosure around one or more sets of custom properties. The content of this element may be used by
custom applications.