FormEvents.Submit 事件

定义

命名空间:

Microsoft.Office.InfoPath

程序集:

Microsoft.Office.InfoPath.dll

在用户界面中使用 Submit 命令或使用 Submit() 方法时发生。

public:
 abstract event Microsoft::Office::InfoPath::SubmitEventHandler ^ Submit;

public abstract event Microsoft.Office.InfoPath.SubmitEventHandler Submit;

member this.Submit : Microsoft.Office.InfoPath.SubmitEventHandler 

Public MustOverride Custom Event Submit As SubmitEventHandler 

事件类型

SubmitEventHandler

例外

InvalidOperationException

开发人员尝试绑定 InternalStartup 方法以外的某个位置的事件。

示例

在以下示例中，如果表单尚未保存，则事件事件处理程序 Submit 用于阻止提交表单。

public void FormEvents_Submit(object sender, SubmitEventArgs e)
{
   if(this.Dirty || this.New)
      MessageBox.Show("Please save this form before submitting it.");
      e.CancelableArgs.Cancel = true;
   else
      e.CancelableArgs.Message = "Submit succeeded.";
}

Public Sub FormEvents_Submit(ByVal sender As Object, _
   ByVal e As SubmitEventArgs)
   If(Me.Dirty Or Me.New) Then
      MessageBox.Show("Please save this form before submitting it.")
      e.CancelableArgs.Cancel = True
   Else
      e.CancelableArgs.Message = "Submit succeeded."
   End If
End Sub

注解

重要提示：开发人员 Submit 不应在表单代码中实例化该事件。 应仅从 Microsoft InfoPath 设计模式用户界面为表单级事件添加事件处理程序。 从设计模式用户界面向表单模板添加事件处理程序时，InfoPath 使用 EventManager 类和 类的成员FormEvents在表单代码文件的 InternalStartup 方法中生成代码，以将事件绑定到其事件处理程序。 有关如何在 InfoPath 设计模式下添加事件处理程序的信息，请参阅如何：添加事件处理程序。

Submit仅当表单模板在“提交选项”对话框中设置了“使用代码执行自定义操作”选项时，才会引发该事件。

使用 Submit 委托绑定 SubmitEventHandler 事件。

可以使用 类的 MergeEventArgs 属性将 Cancel 属性设置为 true 来取消事件。CancelableArgsSubmit

如果事件处理程序代码使用 CancelableArgs 属性设置 或 MessageDetails 属性的Message字符串，但 CancelableArgs.Cancel 属性保留为默认值 false，则会显示一条成功消息，其中包含 Message 和 MessageDetails 属性的文本。 此消息将重写“表单提交选项”对话框中的“显示成功或失败消息”和“成功时”自定义消息设置。

同样，如果事件处理程序代码设置 Message 或 MessageDetails 字符串，并将 CancelableArgs.Cancel 设置为 true，则会显示一条失败消息，消息将显示为 Message 和 MessageDetails 属性的文本，覆盖“表单提交选项”对话框设置。

如果事件处理程序代码将 Message 和 MessageDetails 属性保留为 null 引用的默认值 (Visual Basic) 中的 Nothing，但将 CancelableArgs.Cancel 设置为 true，则认为提交操作已失败。 是否显示失败消息以及显示何种失败消息将由“提交选项”对话框中的设置确定。

Quit()不能在事件处理程序中调用 类的 Submit 方法Application。

可以通过 Microsoft InfoPath Filler 或 Web 浏览器内打开的表单中运行的代码访问此类型或成员。