BeforeRowsDeleted イベント

１つ以上の行が削除される前に発生します。

シンタックス

Visual Basic

'宣言
 
Public Event BeforeRowsDeleted As BeforeRowsDeletedEventHandler

C#

public event BeforeRowsDeletedEventHandler BeforeRowsDeleted

イベント データ

イベント ハンドラが、このイベントに関連するデータを含む、BeforeRowsDeletedEventArgs 型の引数を受け取りました。次の BeforeRowsDeletedEventArgs プロパティには、このイベントの固有の情報が記載されます。

プロパティ	解説
Cancel System.ComponentModel.CancelEventArgsから継承されます。
DisplayPromptMsg	メッセージボックスを表示するかどうかを示す値を設定します。
Rows	行 (読み取り専用)。

解説

rows 引数は、削除される UltraGridRow オブジェクトを含む Rows コレクションへの参照を返します。この参照を使用して、返されたコレクションのプロパティまたはメソッドだけでなく、コレクション内のオブジェクトのプロパティまたはメソッドにもアクセスできます。

displaypromptmsg 引数によってユーザーはデフォルトの確認メッセージを非表示にできます。この引数はユーザー自身のダイアログを表示するために使用できます。

cancel 引数を使用して、行が削除されないようにプログラミングできます。一定の条件が満たされない限り、ユーザーが行を削除できないようにすることが可能です。

このイベントは、ユーザーによる操作、またはプログラム操作で行が削除される時に生成されます。ユーザーが行を削除することを防止するには、オーバーライドの UltraGridOverride.AllowDelete プロパティを False に設定します。Delete メソッドまたは DeleteSelectedRows メソッドを起動して、プログラムで行を削除できます。

デフォルトの確認ダイアログに表示されるテキストは、DialogStrings プロパティを設定して変更できます。

提供された cancel を True に設定しなければ、このイベントの後に AfterRowsDeleted イベント (行が削除されたに発生するイベント) が発生します。

使用例

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub UltraGrid1_BeforeRowsDeleted(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.BeforeRowsDeletedEventArgs) Handles ultraGrid1.BeforeRowsDeleted

      ' グリッドのメッセージ ボックスの表示を回避します
      e.DisplayPromptMsg = False

      ' カスタム メッセージ ボックスを表示します
      Dim result As DialogResult = System.Windows.Forms.MessageBox.Show( _
              "Deleting " & e.Rows.Length.ToString() & " row(s). Continue ?", _
              "Delete rows?", _
              System.Windows.Forms.MessageBoxButtons.YesNo, _
              System.Windows.Forms.MessageBoxIcon.Question)

      ' メッセージ ボックスで [いいえ] がクリックされた場合、行の削除をキャンセルします
      If System.Windows.Forms.DialogResult.No = result Then
          e.Cancel = True
      End If

  End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void ultraGrid1_BeforeRowsDeleted(object sender, Infragistics.Win.UltraWinGrid.BeforeRowsDeletedEventArgs e)
{

	// グリッドのメッセージ ボックスの表示を回避します
	e.DisplayPromptMsg = false;
	 
	// カスタム メッセージ ボックスを表示します
	System.Windows.Forms.DialogResult result =
		System.Windows.Forms.MessageBox.Show( 
		"Deleting " + e.Rows.Length.ToString( ) + " row(s). Continue ?",
		"Delete rows?", 
		System.Windows.Forms.MessageBoxButtons.YesNo, 
		System.Windows.Forms.MessageBoxIcon.Question );
	 
	// メッセージ ボックスで [いいえ] がクリックされた場合、行の削除をキャンセルします
	if ( System.Windows.Forms.DialogResult.No == result )
		e.Cancel = true;

}