ConsoleCancelEventArgs.Cancel プロパティとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

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

索引トップ用語の索引ランキング

ConsoleCancelEventArgs.Cancel プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

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

Visual Basic (宣言)

Public Property Cancel As
 Boolean

Visual Basic (使用法)

Dim instance As ConsoleCancelEventArgs
Dim value As Boolean

value = instance.Cancel

instance.Cancel = value

public bool Cancel { get;
 set; }

C++

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

/** @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。

例外

例外の種類	条件
InvalidOperationException	設定操作でtrue が指定され、Control 修飾子キーと Break コンソールキー (Ctrl + Break) を同時に押してイベントが発生しました。

解説

CancelKeyPress イベントのハンドラが呼び出されると、Cancel プロパティは自動的に false に初期化されます。イベントハンドラが終了したときの Cancel プロパティの値によって、現在のプロセスが再開するか、終了するかが決定されます。

Ctrl + C を押した後の設定操作では、true を指定して、イベントハンドラの終了時に現在のプロセスが再開するように設定します。または、false を指定して、現在のプロセスを終了するように設定します。

Ctrl + Break を押した後の設定操作では、Cancel プロパティの設定に関係なく、現在のプロセスが終了します。つまり、Ctrl + Break を押すと、必ず現在のプロセスが終了します。また、Cancel プロパティを false に設定しても効果がありません。ただし、true を指定すると、例外がスローされます。

使用例

Cancel プロパティを使用してイベントを処理する方法を示すコード例を次に示します。

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
'

// 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

*/

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConsoleCancelEventArgs クラス
ConsoleCancelEventArgs メンバ
System 名前空間
ConsoleCancelEventHandler
ConsoleKey
ConsoleModifiers
SpecialKey

このページでは「.NET Framework クラスライブラリリファレンス」からConsoleCancelEventArgs.Cancel プロパティを検索した結果を表示しています。
Weblioに収録されているすべての辞書からConsoleCancelEventArgs.Cancel プロパティを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からConsoleCancelEventArgs.Cancel プロパティを検索

>> 「ConsoleCancelEventArgs.Cancel プロパティ」を含む用語の索引
ConsoleCancelEventArgs.Cancel プロパティのページへのリンク

ConsoleCancelEventArgs.Cancel プロパティとは？わかりやすく解説

ConsoleCancelEventArgs.Cancel プロパティ

「ConsoleCancelEventArgs.Cancel プロパティ」の関連用語


	© 2025 Microsoft.All rights reserved.

ConsoleCancelEventArgs.Cancel プロパティとは？ わかりやすく解説

ConsoleCancelEventArgs.Cancel プロパティ

急上昇のことば

「ConsoleCancelEventArgs.Cancel プロパティ」の関連用語

ConsoleCancelEventArgs.Cancel プロパティとは？わかりやすく解説