Esta documentación está archivada y no tiene mantenimiento.

ConsoleCancelEventArgs (Clase)

Nota: esta clase es nueva en la versión 2.0 de .NET Framework.

Proporciona datos del evento Console.CancelKeyPress. Esta clase no se puede heredar.

Espacio de nombres: System
Ensamblado: mscorlib (en mscorlib.dll)

[SerializableAttribute] 
public sealed class ConsoleCancelEventArgs : EventArgs
/** @attribute SerializableAttribute() */ 
public final class ConsoleCancelEventArgs extends EventArgs
SerializableAttribute 
public final class ConsoleCancelEventArgs extends EventArgs

Un usuario puede interrumpir un proceso de aplicación en la consola presionando simultáneamente la tecla modificadora Control y la tecla C de la consola (CTRL+C), o la tecla modificadora Control y la tecla INTER (CTRL+INTER) de la consola. A continuación, .NET Framework proporciona un objeto ConsoleCancelEventArgs al controlador de eventos del evento Console.CancelKeyPress.

Si se presiona CTRL+C y la propiedad Cancel del controlador de eventos está establecida en true, se reanuda el proceso; de lo contrario, el proceso finaliza. Al presionar CTRL+INTER, el proceso finaliza si la propiedad Cancel está establecida en false, y se produce una excepción si la propiedad Cancel está establecida en true.

En el ejemplo de código siguiente se muestra cómo utilizar la clase ConsoleCancelEventArgs para controlar un evento.

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

*/

System.Object
   System.EventArgs
    System.ConsoleCancelEventArgs

Los miembros estáticos públicos (Shared en Visual Basic) de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Windows 98, Windows 2000 SP4, Windows Millennium, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter Edition

.NET Framework no admite todas las versiones de cada plataforma. Para obtener una lista de las versiones admitidas, vea Requisitos del sistema.

.NET Framework

Compatible con: 2.0
Mostrar: