ConsoleCancelEventArgs Class
TOC
Collapse the table of content
Expand the table of content

ConsoleCancelEventArgs Class

 

Provides data for the Console.CancelKeyPress event. This class cannot be inherited.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

System.Object
  System.EventArgs
    System.ConsoleCancelEventArgs

[<Sealed>]
[<SerializableAttribute>]
type ConsoleCancelEventArgs = 
    class
        inherit EventArgs
    end

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process.

System_CAPS_pubpropertySpecialKey

Gets the combination of modifier and console keys that interrupted the current process.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

A user can interrupt a console application process by simultaneously pressing the Control modifier key and the C console key (Ctrl+C), or the Control modifier key and the Break console key (Ctrl+Break). The .NET Framework consequently provides a ConsoleCancelEventArgs object to the event handler for the Console.CancelKeyPress event to specify whether the process should be cancelled.

If the Cancel property is set to true in the event handler, the process is resumed; otherwise, the process is terminated. By default, the value of the ConsoleCancelEventArgs property is false, and the process terminates.

The following example demonstrates how to use the ConsoleCancelEventArgs class to handle an event.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft