_XDocumentEventSink2_Event.OnSubmitRequest event

Office 2013 and later

Occurs when the submit operation is invoked either from the Microsoft InfoPath user interface or by using Submit method.

Namespace:  Microsoft.Office.Interop.InfoPath.SemiTrust
Assembly:  Microsoft.Office.Interop.InfoPath.SemiTrust (in Microsoft.Office.Interop.InfoPath.SemiTrust.dll)

event _XDocumentEventSink2_OnSubmitRequestEventHandler OnSubmitRequest

This event handler allows users to cancel a Submit operation.

If the ReturnStatus property of the DocReturnEventObject object is set to false, InfoPath cancels the submit operation. If an error occurs in the scripting code for the OnSubmitRequest event, InfoPath ignores it and relies on the ReturnStatus property. If the ReturnStatus property is not explicitly set, the default value of false is used.

In the following example, the OnSubmitRequest event handler is used to prevent the Submit operation if the form has not been saved.

public void OnSubmitRequest(DocReturnEvent e)
 if(thisXDocument.IsDirty || thisXDocument.IsNew)
 thisXDocument.UI.Alert("Please save this form before submitting");
 e.ReturnStatus = true;