When a row with a repeated element or container was added.
Data with added row.
A callback for when form data was loaded via $.xutil.load. This callback is invoked after the form data was
loaded and the form was updated with the new data. You can use this callback to perform additional actions
after the form was loaded, such as updating the UI of rich widgets.
Data passed by the framework with the form data that was loaded.
A callback for printing the form. The callbacks are invoked after a form was printed (such as by the print service). You can use this callback to undo preparations made by print.
Data passed by the framework for the print operation.
A promise that resolves the cleanup is done.
A callback for when form data was saved via $.xutil.save. This callback is invoked after the form data was
saved. You can use this callback to perform additional actions after the form data was saved, such as inserting
additional data into the form data.
Data passed by the framework with the form data map to fill.
Before a row with a repeated element or container is added.
Data with the row to add.
Optional result object that can be used e.g. to prevent the row from being added.
Before the values of a set of form elements are cleared.
Before a row with a repeated element or container is deleted.
Data with the row to remove.
Optional result object that can be used e.g. to prevent the row from being deleted.
A callback for when form data is about to be loaded via $.xutil.load. This callback is invoked at the beginning,
before any other form data was loaded. You can use this callback to perform additional actions, such as
adjusting the DOM or inserting additional form data. You can also use the return value to exclude
certain elements from the default handler that loads all data for .XItem elements.
Data passed by the framework with the form data to be loaded.
Optional result object that can be used e.g. to exclude certain elements from the default handler.
Before the values of a set of form elements are reset to their default values.
A callback for when form data is about to be saved via $.xutil.save. This callback is invoked at the beginning,
before any other form data was saved. You can use this callback to perform additional actions, such as
adjusting the DOM or inserting values into the form data. You can also use the return value to exclude
certain elements from the default handler that saves all data from .XItem elements.
Data passed by the framework with the form data map fill.
Optional result object that can be used e.g. to exclude certain elements from the default handler.
When the value of a form element was cleared.
When a row with a repeated element or container was deleted.
Data with added row.
When a form element was disabled.
When a form element was enabled.
When a file was changed, both for normal and for automatic upload elements.
When a form element was switched from visible to hidden.
When the current navigation state is restores, e.g. which pages are currently shown.
Listeners can restore custom state that was saved via the saveNavigation event. The navigation state returned by
listeners for saveNavigation is passed as an argument to the loadNavigation event.
Data with the form and the navigation state.
A callback for the print service. The callbacks are invoked when just before a form is printed (such as by the print service). You can use this callback to prepare the form for printing. When the callback returns a promise, the print service waits for the promise to fulfill before printing the form. When the promise is rejected, the error is logged, but does not prevent the print.
To clean up after printing, use afterPrint.
Data passed by the framework for the print operation.
A promise that completes when the preparations are done.
When a form element was set to read-only.
When a set of form elements hda their values reset to the default values.
When the current navigation state is saved, e.g. which pages are currently shown.
Listeners can return custom state to save. Can be used in conjunction with the loadNavigation event to
restore the state later. The navigation state returned by listeners is passed as an argument to the loadNavigation
event.
Data with the form and the current navigation state.
When a form element was switched from hidden to visible.
A callback for when the form is submitted. Can be used e.g. to run additional actions or to prevent the submission.
The callback is called after the form was validated, if the submit button requires validation.
$.xutil.on("submit", () => doSomething())
$.xutil.on("submit", ({submissionBlocked}) => {
// Check if the submission is already blocked
if (submissionBlocked) {
return;
}
// Custom code to be run on submission
// Custom logic to check whether the form submission should be cancelled.
const preventSubmission = customLogic();
return { preventSubmission };
});
Data with the form and whether the submission was already blocked.
Optional result data that can be used e.g. to prevent the submission.
Mapping between event names and callback types for callbacks that can be registered via XUtil.on.