Loading...

Last updated: Nov 02 2016

Area: Episerver Add-ons Applies to versions: 2 and higher

Handling events

Note: Episerver Forms is only supported by MVC-based websites and HTML5-compliant browsers.

jQuery clientside events

The following JavaScript code shows how to handle client-side epiforms events in Alloy MVC templates.

    if (typeof $$epiforms !== 'undefined') {
        $$epiforms(document).ready(function myfunction() {
            console.log('listen to event');
            $$epiforms(".EPiServerForms").on("formsNavigationNextStep formsNavigationPrevStep formsSetupCompleted formsReset formsStartSubmitting formsSubmitted formsSubmittedError formsNavigateToStep formsStepValidating", function (event, param1, param2) {
                console.log($(this).get(0), event);
            });
        });
    }

For a QuickSilver site, put the following script before @Html.RequiredClientResources("Footer").

if (typeof $$epiforms !== 'undefined') {
console.log('listen to event');
$$epiforms(".EPiServerForms").on("formsLoadExternalScripts formsLoadExternalCss", function (event, param1, param2) {
console.log($(this).get(0), event);
}); }

The following jQuery event objects are notification-only:

  • type. Type of event.
  • working form DOM element. The DOM element raises the event.
  • workingFormInfo. Contains meta-information of current Episerver Forms.
  • formData. In some submitting-related events, this property contains the standard FormData object of the submission.

.NET events

Form submissions (and form step submissions) must result in events.

  • FormsStructureChange
  • FormsStepSubmitted
  • FormsSubmissionFinalized
  • FormsSubmitting

The following example code catches server-side events in InitializationModule:

// get the Forms Event Manager to listen to its events
var formsEvents = ServiceLocator.Current.GetInstance<FormsEvents>();
formsEvents.FormsStructureChange += OnStructureChange;
formsEvents.FormsSubmitting += OnSubmitting1;
formsEvents.FormsSubmitting += OnSubmitting2;
formsEvents.FormsStepSubmitted += OnStepSubmit;
formsEvents.FormsSubmissionFinalized += OnFormFinalized;

With FormsSubmitting, FormsStepSubmitted, and FormsSubmissionFinalized events, you can cast the eventArgs to FormsSubmittingEventArgs, where you can get information from SubmissionData (having SubmissionData.Data as IDictionary<string, object>) and the FormSubmissionId.

List of events

  • formsNavigationNextStep
  • formsNavigationPrevStep
  • formsSetupCompleted
  • formsReset
  • formsStartSubmitting
  • formsSubmitted
  • formsSubmittedError
  • formsNavigateToStep
  • formsStepValidating
  • FormsStructureChange
  • FormsStepSubmitted
  • FormsSubmissionFinalized
  • FormsSubmitting

Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/