Events Class

Defines a set of consumable events that can be raised by a console application.

Inheritance Hierarchy

SystemObject
GSF.ConsoleEvents

Namespace: GSF.Console
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.282-beta+fbfa6baa1521236175f6d73fb2eb151a42453aef

Syntax

C++

JavaScript

Copy

public static class Events

Public NotInheritable Class Events

public ref class Events abstract sealed

[<AbstractClassAttribute>]
[<SealedAttribute>]
type Events = class end

GSF.Console.Events = function();

Type.createClass(
	'GSF.Console.Events');

View Source

The Events type exposes the following members.

Methods

	Name	Description
	DisableRaisingEvents	Enables the raising of console application Events.
	EnableRaisingEvents	Enables the raising of console application Events. Prior to calling this method, handlers must be defined for the Events raised by a console application.

Top

Events

	Name	Description
	BreakKeyPress	Occurs when CTRL+BREAK signal is received from keyboard input.
	CancelKeyPress	Occurs when CTRL+C signal is received from keyboard input.
	ConsoleClosing	Occurs when the user closes the console application window.
	SystemShutdown	Occurs when the system is shutting down.
	UserLoggingOff	Occurs when the user is logging off.

Top

Remarks

Note that no events will be raised by this class when running under Mono deployments, the class remains available in the Mono build as a stub to allow existing code to still compile and run.

Example

This example shows how to subscribe to console application events:


             using System;
             using GSF.Console;
            
             class Program
             {
                 static void Main(string[] args)
                 {
                     // Subscribe to console events.
                     Events.CancelKeyPress += Events_CancelKeyPress;
                     Events.ConsoleClosing += Events_ConsoleClosing;
                     Events.EnableRaisingEvents();
                    
                     Console.ReadLine();
                 }
                
                 static void Events_CancelKeyPress(object sender, System.ComponentModel.CancelEventArgs e)
                 {
                     // Abort processing.
                 }
                
                 static void Events_ConsoleClosing(object sender, System.ComponentModel.CancelEventArgs e)
                 {
                     // Put clean-up code.
                 }
             }

Reference

GSF.Console Namespace