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 は、 クラスと クラスのメンバーFormEventsを使用してEventManager、フォーム コード ファイルの InternalStartup メソッドでコードを生成し、イベントをイベント ハンドラーにバインドします。 InfoPath のデザイン モードでイベント ハンドラーを追加する方法の詳細については、「[方法] イベント ハンドラーを追加する方法」を参照してください。

イベントは Submit 、フォーム テンプレートの [送信オプション] ダイアログ ボックスで [コードを使用してカスタム アクションを実行する] オプションが設定されている場合にのみ発生します。

イベントは Submit デリゲートを SubmitEventHandler 使用してバインドされます。

イベントはSubmit、 クラスの プロパティをCancelableArgs使用して Cancel プロパティを MergeEventArgstrue に設定することで取り消すことができます。

イベント ハンドラー コードで プロパティを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() メソッドの Application 呼び出しは、イベント ハンドラーで Submit 行うことはできません。

この型またはメンバーには、Microsoft InfoPath Filler または Web ブラウザーで開いたフォームで実行されるコードからアクセスできます。