ConsoleCancelEventArgs Classe

Definizione

Spazio dei nomi:

System

Assembly:

netstandard.dll, System.Console.dll

Origine:

ConsoleCancelEventArgs.cs

Fornisce dati per l'evento CancelKeyPress. La classe non può essere ereditata.

C#

public sealed class ConsoleCancelEventArgs : EventArgs

Ereditarietà

Object

EventArgs

ConsoleCancelEventArgs

Esempio

Nell'esempio seguente viene illustrato come usare la ConsoleCancelEventArgs classe per gestire un 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

Commenti

Un utente può interrompere un processo dell'applicazione console premendo contemporaneamente il tasto di modifica e il ControlC tasto della console (CTRL+C) o il Control tasto di modifica e il tasto Break console (CTRL+INTERR). Di conseguenza, .NET fornisce un ConsoleCancelEventArgs oggetto al gestore eventi per l'evento Console.CancelKeyPress per specificare se il processo deve essere annullato.

Se la Cancel proprietà è impostata su true nel gestore eventi, il processo viene ripreso; in caso contrario, il processo viene terminato. Per impostazione predefinita, il valore della ConsoleCancelEventArgs proprietà è falsee il processo termina.

Proprietà

Cancel	Ottiene o imposta un valore che indica se premendo il tasto di modifica Control e il tasto della console C (CTRL+C) o i tasti CTRL+INTERR viene terminato il processo corrente. L'impostazione predefinita è false, che termina il processo corrente.
SpecialKey	Ottiene la combinazione di tasti di modifica e della console che hanno causato l'interruzione del processo corrente.

Metodi

Equals(Object)	Determina se l'oggetto specificato è uguale all'oggetto corrente. (Ereditato da Object)
GetHashCode()	Funge da funzione hash predefinita. (Ereditato da Object)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Si applica a