The xforms-refresh event

Release 2.0 - ...

Dispatched in response to: a request to update all form controls associated with a particular XForms Model.

Event Properties

Event Properties Value / Description
Target model
Bubbles Yes
Cancelable Yes
Context Info None

The default action for this event results in the following:

  • All UI Expressions are reevaluated.
  • A node can be changed by a number of mechanisms in XForms, including confirmed user input to a form control, an xforms-recalculate, and the setvalue action. If the value of an instance data node was changed, then the node will be marked for dispatching the xforms-value-changed event.
  • If the xforms-value-changed event is marked for dispatching, then all of the appropriate model item property notification events will also be marked for dispatching (xforms-optional or xforms-required, xforms-readwrite or xforms-readonly, and xforms-enabled or xforms-disabled).
  • The user interface reflects the state of the model, which means that all forms controls and related UI elements reflect their corresponding instance data.

 

Example

XML CopyCode image Copy Code
<xforms:action ev:event="xforms-refresh">
   <xforms:message level="modal">xforms-refresh</xforms:message>
</xforms:action>

Specification

Link to the XForms specification: the xforms-refresh event.