FormEvents.Submit-Ereignis
Tritt ein, wenn der Befehl Absenden von der Benutzeroberfläche verwendet wird, oder bei Verwendung der Submit-Methode.
Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in Microsoft.Office.InfoPath.dll)
Syntax
'Declaration
Public MustOverride Event Submit As SubmitEventHandler
'Usage
Dim instance As FormEvents
Dim handler As SubmitEventHandler
AddHandler instance.Submit, handler
public abstract event SubmitEventHandler Submit
Ausnahmen
| Ausnahme | Bedingung |
|---|---|
| InvalidOperationException | Es wurde versucht, das Ereignis an einen anderen Speicherort als die InternalStartup-Methode zu binden. |
Hinweise
Wichtig
Das Submit-Ereignis sollte nicht vom Entwickler im Formularcode instanziiert werden. Ereignishandler für Ereignisse auf Formularebene sollten nur über die Microsoft InfoPath-Entwurfsmodus-Benutzeroberfläche hinzugefügt werden. Wenn Sie der Formularvorlage über die Entwurfsmodus-Benutzeroberfläche einen Ereignishandler hinzufügen, wird in InfoPath mithilfe der EventManager-Klasse und des Members der FormEvents-Klasse in der InternalStartup-Methode der Formularcodedatei Code generiert, um das Ereignis an den zugehörigen Ereignishandler zu binden. Weitere Informationen zum Hinzufügen von Ereignishandlern im InfoPath-Entwurfsmodus finden Sie unter Vorgehensweise: Hinzufügen eines Ereignishandlers.
Das Submit-Ereignis wird nur ausgelöst, wenn in der Formularvorlage im Dialogfeld Absendeoptionen die Option Benutzerdefinierte Aktion mithilfe von Code ausführen festgelegt ist.
Das Submit-Ereignis wird mithilfe des SubmitEventHandler-Delegats gebunden.
Das Submit-Ereignis kann mithilfe der CancelableArgs-Eigenschaft der MergeEventArgs-Klasse abgebrochen werden, um die Cancel-Eigenschaft auf true festzulegen.
Wenn Ereignishandlercode mithilfe der CancelableArgs-Eigenschaft die Zeichenfolgen der Message- oder MessageDetails-Eigenschaften festlegt, jedoch die CancelableArgs.Cancel-Eigenschaft mit der Standardeinstellung false übernimmt, dann wird eine Erfolgsmeldung mit dem Text der Message- und MessageDetails-Eigenschaften angezeigt. Diese Meldung setzt im Dialogfeld Absendeoptionen die benutzerdefinierten Meldungseinstellungen Meldungen bei Erfolg oder bei Fehler anzeigen und Bei Erfolg außer Kraft.
Das gleiche gilt, wenn der Ereignishandlercode die Message- oder MessageDetails-Zeichenfolge festlegt, und dabei CancelableArgs.Cancel auf true festlegt, dann wird eine Fehlermeldung angezeigt. Die Meldung wird mit dem Text der Message- und MessageDetails-Eigenschaften angezeigt, wobei die Einstellungen des Dialogfeldes Absendeoptionen außer Kraft gesetzt werden.
Wenn der Ereignishandlercode den Standardwert ein Nullverweis (Nothing in Visual Basic) für die Message- und MessageDetails-Eigenschaften übernimmt, jedoch CancelableArgs.Cancel auf true festlegt, dann wird der Sendevorgang einen Fehler zurückgeben. Ob und welche Fehlermeldung angezeigt wird, ist abhängig von den Einstellungen des Dialogfeldes Absendeoptionen.
Aufrufe der Quit-Methode der Application-Klasse sind im Submit-Ereignishandler nicht möglich.
Auf diesen Typ oder dieses Mitglied kann über Code zugegriffen werden, der in Formularen ausgeführt wird, die in Microsoft InfoPath Filler oder in einem Webbrowser geöffnet wurden.
Beispiele
Im folgenden Beispiel wird mit dem Ereignishandler des Submit-Ereignisses das Senden des Formulars verhindert, wenn das Formular nicht gespeichert wurde.
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