CancelEventArgs クラス

定義

キャンセルできるイベントのデータを提供します。Provides data for a cancelable event.

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

次の例では、CancelEventArgsCancelEventHandler を使用して、FormClosing イベントを処理します。The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. このコードでは、isDataSavedという名前のクラスレベル Boolean 変数を持つ Form が作成されていることを前提としています。This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. また、ステートメントを追加して、フォームの Load メソッドまたはコンストラクター (InitializeComponentへの呼び出しの後) から OtherInitialize メソッドを呼び出すことを前提としています。It also assumes that you have added a statement to invoke the OtherInitialize method from the form's Load method or the constructor (after the call to 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

注釈

キャンセル可能なイベントは、FormClosing イベントなど、取り消すことができるアクションを実行しようとすると、コンポーネントによって発生します。A cancelable event is raised by a component when it is about to perform an action that can be canceled, such as the Closing event of a Form.

注意

Closing イベントは非推奨とされ、FormClosingに置き換えられました。The Closing event is deprecated and has been replaced by FormClosing. ここでは、CancelEventArgsの使用方法を示すことだけを目的としています。It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgs には、イベントを取り消すかどうかを示す Cancel プロパティが用意されています。CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

コンストラクター

CancelEventArgs()

CancelEventArgs プロパティを Cancel に設定して、false クラスの新しいインスタンスを初期化します。Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean)

CancelEventArgs プロパティを特定の値に設定して、Cancel クラスの新しいインスタンスを初期化します。Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

プロパティ

Cancel

イベントをキャンセルするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the event should be canceled.

メソッド

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象

こちらもご覧ください