CancelEventArgs クラス

定義

キャンセルできるイベントのデータを提供します。

public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
    inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
継承
CancelEventArgs
派生

次の例では、とを使用して CancelEventArgs CancelEventHandler Closing 、のイベントを処理し Form ます。 このコードは、という名前のクラスレベルの変数を持つを作成済みであることを前提としてい Form Boolean isDataSaved ます。 また、 OtherInitialize フォームの Load メソッドまたはコンストラクター (の呼び出しの後) からメソッドを呼び出すステートメントを追加したことを前提としてい InitializeComponent ます。

private:
   // Call this method from the InitializeComponent() method of your form
   void OtherInitialize()
   {
      this->Closing += gcnew CancelEventHandler( this, &Form1::Form1_Cancel );
      this->myDataIsSaved = true;
   }

   void Form1_Cancel( Object^ /*sender*/, CancelEventArgs^ e )
   {
      if ( !myDataIsSaved )
      {
         e->Cancel = true;
         MessageBox::Show( "You must save first." );
      }
      else
      {
         e->Cancel = false;
         MessageBox::Show( "Goodbye." );
      }
   }
// Call this method from the constructor of your form
    private void OtherInitialize() {
       this.Closing += new CancelEventHandler(this.Form1_Closing);
       // Exchange commented line and note the difference.
       this.isDataSaved = true;
       //this.isDataSaved = false;
    }

    private void Form1_Closing(Object sender, CancelEventArgs e) {
       if (!isDataSaved) {
          e.Cancel = true;
          MessageBox.Show("You must save first.");
       }
       else {
          e.Cancel = false;
          MessageBox.Show("Goodbye.");
       }
    }
' Call this method from the Load method of your form.
Private Sub OtherInitialize()
    ' Exchange commented line and note the difference.
    Me.isDataSaved = True
    'Me.isDataSaved = False
End Sub

Private Sub Form1_Closing(sender As Object, e As _
   System.ComponentModel.CancelEventArgs) Handles MyBase.Closing
    If Not isDataSaved Then
        e.Cancel = True
        MessageBox.Show("You must save first.")
    Else
        e.Cancel = False
        MessageBox.Show("Goodbye.")
    End If
End Sub

注釈

取り消し可能なイベントは、のイベントなど、キャンセル可能なアクションを実行しようとしているときに、コンポーネントによって発生し Closing Form ます。

注意

Closingイベントは非推奨とされ、に置き換えられました FormClosing 。 この例では、の使用方法を説明するためだけに示してい CancelEventArgs ます。

CancelEventArgs イベントを Cancel 取り消すかどうかを示すプロパティを提供します。

コンストラクター

CancelEventArgs()

CancelEventArgs プロパティを false に設定して、Cancel クラスの新しいインスタンスを初期化します。

CancelEventArgs(Boolean)

CancelEventArgs プロパティを特定の値に設定して、Cancel クラスの新しいインスタンスを初期化します。

プロパティ

Cancel

イベントをキャンセルするかどうかを示す値を取得または設定します。

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

適用対象

こちらもご覧ください