CancelEventArgs

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

CancelEventArgs クラス

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

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

Visual Basic (宣言)

Public Class CancelEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As CancelEventArgs

C#

public class CancelEventArgs : EventArgs

C++

public ref class CancelEventArgs : public
 EventArgs

J#

public class CancelEventArgs extends EventArgs

JScript

public class CancelEventArgs extends
 EventArgs

解説

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

CancelEventArgs には、イベントをキャンセルするかどうかを示す Cancel プロパティがあります。

メモ
このクラスに適用される HostProtectionAttribute 属性の Resources プロパティの値は、SharedState です。HostProtectionAttribute は、デスクトップ アプリケーション (一般的には、アイコンをダブルクリック、コマンドを入力、またはブラウザに URL を入力して起動するアプリケーション) には影響しません。詳細については、HostProtectionAttribute クラスのトピックまたは「SQL Server プログラミングとホスト保護属性」を参照してください。

使用例

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

継承階層

System.Object
   System.EventArgs
    System.ComponentModel.CancelEventArgs
       派生クラス

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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 メンバ
System.ComponentModel 名前空間
CancelEventHandler

CancelEventArgs コンストラクタ ()

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

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New CancelEventArgs

C#

public CancelEventArgs ()

C++

public:
CancelEventArgs ()

J#

public CancelEventArgs ()

JScript

public function CancelEventArgs ()

プラットフォーム

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 名前空間
CancelEventHandler

CancelEventArgs コンストラクタ

CancelEventArgs クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
CancelEventArgs ()	Cancel プロパティを false に設定して、CancelEventArgs クラスの新しいインスタンスを初期化します。 .NET Compact Framework によってサポートされています。
CancelEventArgs (Boolean)	Cancel プロパティを特定の値に設定して、CancelEventArgs クラスの新しいインスタンスを初期化します。 .NET Compact Framework によってサポートされています。

参照

関連項目

CancelEventArgs クラス
CancelEventArgs メンバ
System.ComponentModel 名前空間
CancelEventHandler

CancelEventArgs コンストラクタ (Boolean)

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

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

Visual Basic (宣言)

Public Sub New ( _
    cancel As Boolean _
)

Visual Basic (使用法)

Dim cancel As Boolean

Dim instance As New CancelEventArgs(cancel)

C#

public CancelEventArgs (
    bool cancel
)

C++

public:
CancelEventArgs (
    bool cancel
)

J#

public CancelEventArgs (
    boolean cancel
)

JScript

public function CancelEventArgs (
    cancel : boolean
)

パラメータ

cancel

イベントをキャンセルする場合は true。それ以外の場合は false。

プラットフォーム

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 名前空間
CancelEventHandler

CancelEventArgs プロパティ

パブリック プロパティ

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

参照

関連項目

CancelEventArgs クラス
System.ComponentModel 名前空間
CancelEventHandler

CancelEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

CancelEventArgs クラス
System.ComponentModel 名前空間
CancelEventHandler

CancelEventArgs メンバ

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

CancelEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	CancelEventArgs	オーバーロードされます。 CancelEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

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

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

CancelEventArgs クラス
System.ComponentModel 名前空間
CancelEventHandler