ConsoleCancelEventArgs Classe

Définition

Espace de noms:

System

Assemblys:

netstandard.dll, System.Console.dll

Source:

ConsoleCancelEventArgs.cs

Fournit des données pour l'événement CancelKeyPress. Cette classe ne peut pas être héritée.

C#

public sealed class ConsoleCancelEventArgs : EventArgs

Héritage

Object

EventArgs

ConsoleCancelEventArgs

Exemples

L’exemple suivant montre comment utiliser la ConsoleCancelEventArgs classe pour gérer un événement.

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

Remarques

Un utilisateur peut interrompre un processus d’application console en appuyant simultanément sur la Control touche de modification et la C touche de console (Ctrl+C), ou sur la Control touche de modification et la touche De console Arrêt (Ctrl+Arrêt). Par conséquent, .NET fournit un ConsoleCancelEventArgs objet au gestionnaire d’événements pour que l’événement Console.CancelKeyPress spécifie si le processus doit être annulé.

Si la Cancel propriété est définie true sur dans le gestionnaire d’événements, le processus reprend ; sinon, le processus est arrêté. Par défaut, la valeur de la ConsoleCancelEventArgs propriété est false, et le processus se termine.

Propriétés

Cancel	Obtient ou définit une valeur qui indique si le fait d'appuyer simultanément sur la touche de modification Control et la touche de console (Ctrl+C) ou la touche Ctrl + Saut C met fin au processus actuel. La valeur par défaut est false, qui met fin au processus actuel.
SpecialKey	Obtient la combinaison de touches de modification et de clé de console qui a interrompu le processus en cours.

Méthodes

Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

S’applique à