CancelEventArgs.Cancel プロパティ

.NET Framework クラス ライブラリ リファレンス

CancelEventArgs.Cancel プロパティ

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

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Property Cancel As
 Boolean

Visual Basic (使用法)

Dim instance As CancelEventArgs
Dim value As Boolean

value = instance.Cancel

instance.Cancel = value

C#

public bool Cancel { get;
 set; }

C++

public:
property bool Cancel {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_Cancel ()

/** @property */
public void set_Cancel (boolean value)

JScript

public function get Cancel
 () : boolean

public function set Cancel
 (value : boolean)

プロパティ値
イベントをキャンセルする場合は true。それ以外の場合は false。

使用例

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

Visual Basic

' 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

C#

// 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.");
       }
    }
 

C++

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." );
      }
   }

J#

// Calls this method from the InitializeComponent() method of your form
private void OtherInitialize()
{
    this.add_Closing(new CancelEventHandler(this.Form1_Cancel));
    this.myDataIsSaved = (boolean)new System.Boolean();
    this.myDataIsSaved = true;
} //OtherInitialize

protected void Form1_Cancel(Object sender,
 CancelEventArgs e)
{
    if (!(myDataIsSaved)) {
        e.set_Cancel(true);
        MessageBox.Show("You must save first.");
    }
    else {
        e.set_Cancel(false);
        MessageBox.Show("Goodbye.");
    }
} //Form1_Cancel

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
CancelEventArgs クラス
CancelEventArgs メンバ
System.ComponentModel 名前空間