CancelEventArgs CancelEventArgs CancelEventArgs CancelEventArgs Class

定義

キャンセルできるイベントのデータを提供します。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
継承
CancelEventArgsCancelEventArgsCancelEventArgsCancelEventArgs
派生

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

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 'Form1_Closing

注釈

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

注意

イベントは非推奨とされ、にFormClosing置き換えられました。 ClosingThe 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イベントを取り消すかどうかを示すプロパティを提供します。CancelCancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

コンストラクター

CancelEventArgs() CancelEventArgs() CancelEventArgs() CancelEventArgs()

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

CancelEventArgs(Boolean) CancelEventArgs(Boolean) CancelEventArgs(Boolean) CancelEventArgs(Boolean)

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

プロパティ

Cancel Cancel Cancel Cancel

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

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

(Inherited from Object)
GetType() GetType() GetType() GetType()

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

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
ToString() ToString() ToString() ToString()

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

(Inherited from Object)

適用対象

こちらもご覧ください