ConsoleCancelEventArgs

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

ConsoleCancelEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

Console.CancelKeyPress イベントのデータを提供します。このクラスは継承できません。

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

Visual Basic (宣言)

<SerializableAttribute> _
Public NotInheritable Class
 ConsoleCancelEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As ConsoleCancelEventArgs

C#

[SerializableAttribute] 
public sealed class ConsoleCancelEventArgs
 : EventArgs

C++

[SerializableAttribute] 
public ref class ConsoleCancelEventArgs sealed
 : public EventArgs

J#

/** @attribute SerializableAttribute() */ 
public final class ConsoleCancelEventArgs extends
 EventArgs

JScript

SerializableAttribute 
public final class ConsoleCancelEventArgs extends
 EventArgs

解説

ユーザーがコンソール アプリケーション プロセスを中断するには、Control 修飾子キーと C コンソール キー (Ctrl + C) を同時に押すか、Control 修飾子キーと Break コンソール キー (Ctrl + Break) を同時に押します。その結果、.NET Framework によって、ConsoleCancelEventArgs オブジェクトが Console.CancelKeyPress イベントのイベント ハンドラに渡されます。

イベント ハンドラの Cancel プロパティを true に設定した場合に Ctrl + C を押すと、プロセスが再開されます。それ以外の場合は、プロセスが終了します。Cancel プロパティを false に設定した場合に Ctrl + Break を押すと、プロセスが終了します。Cancel プロパティを true に設定した場合に Ctrl + Break を押すと、例外がスローされます。

使用例

ConsoleCancelEventArgs クラスを使用してイベントを処理する方法を示すコード例を次に示します。

Visual Basic

' This example demonstrates:
' the Console.CancelKeyPress event,
' the ConsoleCancelEventHandler delegate, 
' the ConsoleCancelEventArgs.SpecialKey property, and 
' the ConsoleCancelEventArgs.Cancel property.

Imports System

Class Sample
    Public Shared Sub Main()
 
        Dim cki As ConsoleKeyInfo
        
        ' Clear the screen.
        Console.Clear()
        
        ' Turn off the default system behavior when CTRL+C is pressed.
 When 
        ' Console.TreatControlCAsInput is false, CTRL+C is treated as
 an
        ' interrupt instead of as input.
        Console.TreatControlCAsInput = False
        
        ' Establish an event handler to process key press events.
        AddHandler Console.CancelKeyPress, AddressOf
 myHandler

        While True
            ' Prompt the user.
            Console.Write("Press any key, or 'X'
 to quit, or ")
            Console.WriteLine("CTRL+C to interrupt the read operation:")
            
            ' Start a console read operation. Do not display the input.
            cki = Console.ReadKey(True)
            
            ' Announce the name of the key that was pressed .
            Console.WriteLine("  Key pressed: {0}"
 & vbCrLf, cki.Key)
            
            ' Exit if the user pressed the 'X' key.
            If cki.Key = ConsoleKey.X Then
 Exit While
        End While
    End Sub 'Main
     
'   When you press CTRL+C, the read operation is interrupted and the
 
'   console cancel event handler, myHandler, is invoked. Upon entry
 
'   to the event handler, the Cancel property is false, which means
 
'   the current process will terminate when the event handler terminates.
 
'   However, the event handler sets the Cancel property to true, which
 
'   means the process will not terminate and the read operation will
 resume.

    Protected Shared Sub
 myHandler(ByVal sender As Object,
 _
                                   ByVal args As
 ConsoleCancelEventArgs) 
        ' Announce that the event handler has been invoked.
        Console.WriteLine(vbCrLf & "The read operation has
 been interrupted.")
        
        ' Announce which key combination was pressed.
        Console.WriteLine("  Key pressed: {0}", args.SpecialKey)
        
        ' Announce the initial value of the Cancel property.
        Console.WriteLine("  Cancel property: {0}",
 args.Cancel)
        
        ' Set the Cancel property to true to prevent the process from
 terminating.
        Console.WriteLine("Setting the Cancel property to true...")
        args.Cancel = True
        
        ' Announce the new value of the Cancel property.
        Console.WriteLine("  Cancel property: {0}",
 args.Cancel)
        Console.WriteLine("The read operation will resume..."
 & vbCrLf)
    
    End Sub 'myHandler
End Class 'Sample
'
'This code example produces results similar to the following text:
'
'Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
'  Key pressed: J
'
'Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
'  Key pressed: Enter
'
'Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
'
'The read operation has been interrupted.
'  Key pressed: ControlC
'  Cancel property: False
'Setting the Cancel property to true...
'  Cancel property: True
'The read operation will resume...
'
'  Key pressed: Q
'
'Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
'  Key pressed: X
'

C#

// This example demonstrates:
// the Console.CancelKeyPress event,
// the ConsoleCancelEventHandler delegate, 
// the ConsoleCancelEventArgs.SpecialKey property, and 
// the ConsoleCancelEventArgs.Cancel property.

using System;

class Sample 
{
    public static void Main()
    {
    ConsoleKeyInfo cki;

// Clear the screen.
    Console.Clear();

// Turn off the default system behavior when CTRL+C is pressed. When
 
// Console.TreatControlCAsInput is false, CTRL+C is treated as an
// interrupt instead of as input.
    Console.TreatControlCAsInput = false;

// Establish an event handler to process key press events.
    Console.CancelKeyPress += new ConsoleCancelEventHandler(myHandler);
    while (true)
        {
// Prompt the user.
        Console.Write("Press any key, or 'X' to quit, or ");
        Console.WriteLine("CTRL+C to interrupt the read operation:");

// Start a console read operation. Do not display the input.
        cki = Console.ReadKey(true);

// Announce the name of the key that was pressed .
        Console.WriteLine("  Key pressed: {0}\n", cki.Key);

// Exit if the user pressed the 'X' key.
        if (cki.Key == ConsoleKey.X) break;
        }
    }

/*
   When you press CTRL+C, the read operation is interrupted and the 
   console cancel event handler, myHandler, is invoked. Upon entry 
   to the event handler, the Cancel property is false, which means
 
   the current process will terminate when the event handler terminates. 
   However, the event handler sets the Cancel property to true,
 which 
   means the process will not terminate and the read operation will resume.
*/
    protected static void
 myHandler(object sender, ConsoleCancelEventArgs args)
    {
// Announce that the event handler has been invoked.
    Console.WriteLine("\nThe read operation has been interrupted.");

// Announce which key combination was pressed.
    Console.WriteLine("  Key pressed: {0}", args.SpecialKey);

// Announce the initial value of the Cancel property.
    Console.WriteLine("  Cancel property: {0}", args.Cancel);

// Set the Cancel property to true to prevent the process from terminating.
    Console.WriteLine("Setting the Cancel property to true...");
    args.Cancel = true;

// Announce the new value of the Cancel property.
    Console.WriteLine("  Cancel property: {0}", args.Cancel);
    Console.WriteLine("The read operation will resume...\n");
    }
}
/*
This code example produces results similar to the following text:

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
  Key pressed: J

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
  Key pressed: Enter

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:

The read operation has been interrupted.
  Key pressed: ControlC
  Cancel property: False
Setting the Cancel property to true...
  Cancel property: True
The read operation will resume...

  Key pressed: Q

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
  Key pressed: X

*/

C++

// This example demonstrates:
// the Console.CancelKeyPress event,
// the ConsoleCancelEventHandler delegate, 
// the ConsoleCancelEventArgs.SpecialKey property, and 
// the ConsoleCancelEventArgs.Cancel property.

using namespace System;

// When you press CTRL+C, the read operation is interrupted and the
 
// console cancel event handler, myHandler, is invoked. Upon entry 
// to the event handler, the Cancel property is false, which means 
// the current process will terminate when the event handler terminates.
 
// However, the event handler sets the Cancel property to true, which
 
// means the process will not terminate and the read operation will
 resume.
void OnCancelKeyPressed(Object^ sender, 
    ConsoleCancelEventArgs^ args)
{
    // Announce that the event handler has been invoked.
    Console::WriteLine("{0}The read operation has been interrupted.",
        Environment::NewLine);

    // Announce which key combination was pressed.
    Console::WriteLine("  Key pressed: {0}", args->SpecialKey);

    // Announce the initial value of the Cancel property.
    Console::WriteLine("  Cancel property: {0}", args->Cancel);

    // Set the Cancel property to true to prevent the process from 
    // terminating.
    Console::WriteLine("Setting the Cancel property to true...");
    args->Cancel = true;

    // Announce the new value of the Cancel property.
    Console::WriteLine("  Cancel property: {0}", args->Cancel);
    Console::WriteLine("The read operation will resume...{0}",
        Environment::NewLine);
}

int main()
{       
    // Clear the screen.
    Console::Clear();

    // Turn off the default system behavior when CTRL+C is pressed. When
 
    // Console.TreatControlCAsInput is false, CTRL+C is treated as an
    // interrupt instead of as input.
    Console::TreatControlCAsInput = false;

    // Establish an event handler to process key press events.
    Console::CancelKeyPress += 
        gcnew ConsoleCancelEventHandler(OnCancelKeyPressed);

    while (true)
    {
        // Prompt the user.
        Console::Write("Press any key, or 'X' to quit, or ");
        Console::WriteLine("CTRL+C to interrupt the read operation:");

        // Start a console read operation. Do not display the input.
        ConsoleKeyInfo^ keyInfo = Console::ReadKey(true);

        // Announce the name of the key that was pressed .
        Console::WriteLine("  Key pressed: {0}{1}", keyInfo->Key, 
            Environment::NewLine);

        // Exit if the user pressed the 'X' key.
        if (keyInfo->Key == ConsoleKey::X)
        {
            break;
        }
    }
}
/*
This code example produces results similar to the following text:

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
Key pressed: J

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
Key pressed: Enter

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:

The read operation has been interrupted.
Key pressed: ControlC
Cancel property: False
Setting the Cancel property to true...
Cancel property: True
The read operation will resume...

Key pressed: Q

Press any key, or 'X' to quit, or CTRL+C to interrupt the read operation:
Key pressed: X

*/

継承階層

System.Object
   System.EventArgs
    System.ConsoleCancelEventArgs

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
ConsoleCancelEventArgs メンバ
System 名前空間

ConsoleCancelEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	Control 修飾子キーと C コンソール キー (Ctrl + C) を同時に押した場合に現在のプロセスが終了するかどうかを表す値を取得または設定します。
	SpecialKey	現在のプロセスを中断した修飾子キーとコンソール キーの組み合わせを取得します。

参照

関連項目

ConsoleCancelEventArgs クラス
System 名前空間

ConsoleCancelEventArgs メソッド

パブリック メソッド

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

参照

関連項目

ConsoleCancelEventArgs クラス
System 名前空間

ConsoleCancelEventArgs メンバ

Console.CancelKeyPress イベントのデータを提供します。このクラスは継承できません。

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

パブリック プロパティ

	名前	説明
	Cancel	Control 修飾子キーと C コンソール キー (Ctrl + C) を同時に押した場合に現在のプロセスが終了するかどうかを表す値を取得または設定します。
	SpecialKey	現在のプロセスを中断した修飾子キーとコンソール キーの組み合わせを取得します。

パブリック メソッド

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

参照

関連項目

ConsoleCancelEventArgs クラス
System 名前空間