XFA Specification
Chapter 9, Automation Objects
Events
308
Field Events
Field events trigger in response to user actions which affect a field. Some are generated in interactive
contexts and some in both interactive and non-interactive contexts.
A script binds to a field event by expressing a
ref
property whose value is a SOM expression pointing to
the field.
The field events are as follows:
change
This event triggers when the content of the field is changed by the user. This event triggers on
every keystroke as long as the field has keyboard focus. It also triggers when the user pastes into
the field, makes a selection from a choice list or drop-down menu, checks or unchecks a checkbox,
or changes the setting of a set of radio buttons. It is
not
triggered by content changes that are
made by the XFA application, for example calculations, nor is it triggered by a merge operation.
click
This event triggers when a mouse click occurs within the region.
enter
This event triggers when the field gains keyboard focus, whether caused by a user action (tabbing
into the field or clicking on it with the mouse) or by a script programmatically setting the focus.
Starting with XFA 2.4 it also triggers when a new selection is made in a choice list, but this
behavior can be inhibited. See below.
exit
This event triggers when the field loses keyboard focus. Starting with XFA 2.4 it also triggers
whenever a new selection is made in a choice list (followed by an enter event), but this behaviour
can be inhitibited. See below.
full
This event triggers when the user has entered the maximum allowed amount of content into the
field and tries to enter more content.
initialize
This event triggers after data binding is complete. A separate event is generated for each instance
of the field in the Form DOM.
mouseDown
This event triggers when the mouse button is depressed at a moment when the mouse pointer is
within the region.
mouseEnter
This event triggers when the user moves the mouse pointer into the region of the field, without
necessarily pressing the mouse button. It is not triggered when the mouse pointer moves into the
field for some other reason, for example because an overlying window closes.
mouseExit
This event triggers when user moves the mouse pointer out of the field, whether the mouse
button is depressed or not. It is not triggered when the mouse pointer moves out of the field for
some other reason, for example because an overlying window opens.