ConsoleCancelEventArgs Classe

Definição

Namespace:

System

Assemblies:

netstandard.dll, System.Console.dll

Origem:

ConsoleCancelEventArgs.cs

Fornece dados para o evento de CancelKeyPress . Essa classe não pode ser herdada.

C#

public sealed class ConsoleCancelEventArgs : EventArgs

Herança

Object

EventArgs

ConsoleCancelEventArgs

Exemplos

O exemplo a seguir demonstra como usar a ConsoleCancelEventArgs classe para manipular um evento.

C#

using System;

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

        Console.Clear();

        // Establish an event handler to process key press events.
        Console.CancelKeyPress += new ConsoleCancelEventHandler(myHandler);
        while (true)
        {
            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: {cki.Key}\n");

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

    protected static void myHandler(object sender, ConsoleCancelEventArgs args)
    {
        Console.WriteLine("\nThe read operation has been interrupted.");

        Console.WriteLine($"  Key pressed: {args.SpecialKey}");

        Console.WriteLine($"  Cancel property: {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: {args.Cancel}");
        Console.WriteLine("The read operation will resume...\n");
    }
}
// The example displays output similar to the following:
//    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

Comentários

Um usuário pode interromper um processo de aplicativo de console pressionando simultaneamente a Control tecla modificadora e a tecla de C console (Ctrl+C) ou a Control tecla modificadora e a tecla de console Break (Ctrl+Break). Consequentemente, o .NET fornece um ConsoleCancelEventArgs objeto para o manipulador de eventos do Console.CancelKeyPress evento para especificar se o processo deve ser cancelado.

Se a Cancel propriedade estiver definida como true no manipulador de eventos, o processo será retomado; caso contrário, o processo será encerrado. Por padrão, o valor da ConsoleCancelEventArgs propriedade é falsee o processo é encerrado.

Propriedades

Cancel	Obtém ou define um valor que indica se pressionar simultaneamente a tecla modificadora Control e a tecla de console C (Ctrl+C) ou as teclas Ctrl+Break encerra o processo atual. O padrão é false, que encerra o processo atual.
SpecialKey	Obtém a combinação das teclas modificadoras e de console que interromperam o processo atual.

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Aplica-se a