This topic has not yet been rated - Rate this topic

_XDocumentEventSink2_Event.OnSubmitRequest event

Office 2013

Office 2010

This documentation is preliminary and is subject to change.

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)

Syntax

event _XDocumentEventSink2_OnSubmitRequestEventHandler OnSubmitRequest

Remarks

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.

Examples

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

[InfoPathEventHandler(EventType=InfoPathEventType.OnSubmitRequest)]
public void OnSubmitRequest(DocReturnEvent e)
{
 if(thisXDocument.IsDirty || thisXDocument.IsNew)
 thisXDocument.UI.Alert("Please save this form before submitting");
else
 e.ReturnStatus = true;
}

Reference

_XDocumentEventSink2_Event interface

_XDocumentEventSink2_Event members

Microsoft.Office.Interop.InfoPath.SemiTrust namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD