Custom XForms jQuery Events
PRELIMINARY INFORMATION - SUBJECT TO CHANGE
The XForms plugin fires a large number of custom jQuery events while running in the browser. You can hook into any of these events, for instance to prevent default behavior, customize the user interface and enrich controls.
XForms_Message Event
Triggered when messages are sent using the XForms message element. Bind to this event when you have to capture all messages. For modal, modeless and ephemeral messages, specific events exist.
Properties:
- type: message type (string)
- data: message body (string)
XForms_ModalMessage Event
Triggered when a modal (blocking) message is to be shown (message level="modal").
Properties:
- data: message body (string)
XForms_ModelessMessage Event
Triggered when a modeless (non blocking) message is to be shown (message level="modeless").
Properties:
- data: message body (string)
XForms_EphemeralMessage Event
Triggered when an ephemeral (briefly shown, automatically disappearing) message is to be shown (message level="ephemeral").
Properties:
- data: message body (string)
- id: id of the control the ephemeral message is linked to, if any (string)
XForms_Enrich
Triggered on DOM Ready, and whenever an area is updated by the Smart Screen Update mechanism
Properties
- data: element(s) that can be enriched (jQuery selector object)
XForms_Unenrich
Triggered before an area is updated by the Smart Screen Update mechanism, in order to unload any enrichments, unhook event handlers, etc...
Properties
- data: element(s) that can be unenriched (jQuery selector object)
XForms_EffectStart Event
Triggered when the client layer is about to reveal a new element/control in the browser.
Properties
- data: element(s) that will be injected into the browser DOM (jQuery selector object)
XForms_Effect Event
Triggered when an element is shown or hidden.
Properties
- type: type of action to take (string - remove | replace | statechange)
- object1: element that will be removed/replaced (jQuery selector object)
- object2 : element that will be injected into the browser DOM, if type="replace" (jQuery selector object)
XForms_EffectEnd Event
Triggered when the Smart Screen Update routine finishes.
Properties
- data: element(s) that has been injected into the browser DOM (jQuery selector object)
XForms_Error Event
Triggered when an error occurs during form runtime
Properties
- msg: Error message (string)
- errorNumber: current error number (number)
- type: exception type name (string)
- exception: JavaScript Error Object (object)
XForms_SelectControl Event
Triggered when an XForms control is selected (gets the focus)
Properties:
- control: element that gets selected (jQuery selector object)
XForms_Unload Event
Raised when the hosting page in which the XForms document runs is closed, or navigated away from.
XForms_UploadStarting Event
Raised when an XForms upload control is provided with a file to upload.
Properties
- control: upload control (jQuery selector object).
- abort: function to call to abort the upload (function).
- frame: IFRAME element (hidden) in which the upload is processed (jQuery selector object).
XForms_UploadAborted Event
Raised when an XForms upload is aborted.
Properties
- control: upload control (jQuery selector object).
XForms_UploadReady Event
Raised when an XForms upload is ready.
Properties
- control: upload control (jQuery selector object).
XForms_ReadyStateChange Event
Triggered when Ajax callbacks are done by XForms.
Properties
- ready: indicates form readystate (Boolean)
- origin: element that caused the state change (jQuery selector object)