C# Source Code: Console window utility class
[
Home
|
Contents
|
Search
|
Reply
| Previous | Next ]
C# Source Code
Console window utility class
By:
Andrew Baker
Email (spam proof):
Email the originator of this post
Date:
Monday, November 14, 2005
Hits:
2050
Category:
General/Framework
Article:
Below is the console utility class which extends the .NET Console class. The class has a number of useful functions including setting the title, changing text attributes (inc forecolor and backcolor) and creating and destroying the console window. using System; using System.Runtime.InteropServices; using System.Text; /// <summary> /// www.VBusers.com. Static library class providing a number of useful functions for using Console windows. /// By Andrew Baker. /// </summary> public class ConsoleLib { #region Enums /// <summary> /// Enumeration containing console attributes flags. /// </summary> public enum ConsoleAttributes: int { /// <summary> /// Text color contains blue. /// </summary> ForegroundBlue = 0x0001, /// <summary> /// Text color contains green. /// </summary> ForegroundGreen = 0x0002, /// <summary> /// Text color contains red. /// </summary> ForegroundRed = 0x0004, /// <summary> /// Text color is intensified. /// </summary> ForegroundIntensity = 0x0008, /// <summary> /// Background color contains blue. /// </summary> BackgroundBlue = 0x0010, /// <summary> /// Background color contains green. /// </summary> BackgroundGreen = 0x0020, /// <summary> /// Background color contains red. /// </summary> BackgroundRed = 0x0040, /// <summary> /// Background color is intensified. /// </summary> BackgroundIntensity = 0x0080, /// <summary> /// Leading byte. /// </summary> LeadingByte = 0x0100, /// <summary> /// Trailing byte. /// </summary> TrailingByte = 0x0200, /// <summary> /// Top horizontal. /// </summary> GridHorizontal = 0x0400, /// <summary> /// Left vertical. /// </summary> GridLeftVertical = 0x0800, /// <summary> /// Right vertical. /// </summary> GridRightVertical = 0x1000, /// <summary> /// Reverse foreground and background attributes /// </summary> ReverseVideo = 0x4000, /// <summary> /// Underscore. /// </summary> Underscore = 0x8000 } #endregion Enums #region Constants /// <summary> /// Gets the standard out handle. /// </summary> private const int STD_OUTPUT_HANDLE = -11; /// <summary> /// Gets the standard input handle. /// </summary> private const int STD_INPUT_HANDLE = -10; #endregion #region Structs /// <summary> /// Structure to hold data read from console stream. /// </summary> [StructLayout(LayoutKind.Sequential)] private struct INPUT_RECORD { public ushort EventType; public uint bKeyDown; public ushort wRepeatCount; public ushort wVirtualKeyCode; public ushort wVirtualScanCode; public char UnicodeChar; public uint dwControlKeyState; } #endregion #region Console API Imports /// <summary> /// The ReadConsoleInput function reads data from a console input buffer and removes it from the buffer. /// </summary> /// <param name="hConsoleInput">Handle to the console input buffer.</param> /// <param name="lpBuffer">Pointer to an array of INPUT_RECORD structures that receives the input buffer data. /// The total size of the array required will be less than 64K.</param> /// <param name="nLength">Size of the array pointed to by /// the lpBuffer parameter, in array elements.</param> /// <param name="lpNumberOfEventsRead">Pointer to a variable that /// receives the number of input records read.</param> /// <returns>If the function succeeds, the return value is nonzero.</returns> [DllImport("kernel32", CharSet=CharSet.Auto, SetLastError=true)] private static extern bool ReadConsoleInput( IntPtr hConsoleInput, [Out] INPUT_RECORD[] lpBuffer, int nLength, out int lpNumberOfEventsRead); /// <summary> /// The WriteConsole function writes a character string to /// a console screen buffer beginning at the current cursor location. /// </summary> /// <param name="hConsoleOutput">Handle to the console screen buffer. The handle must have the GENERIC_WRITE access right.</param> /// <param name="lpBuffer">Pointer to a buffer that contains characters to be written to the console screen buffer.</param> /// <param name="nNumberOfCharsToWrite">Number of TCHARs to write.</param> /// <param name="lpNumberOfCharsWritten">Pointer to a variable that receives the number of TCHARs actually written</param> /// <param name="lpReserved">Reserved; must be NULL.</param> /// <returns>If the function succeeds, the return value is nonzero.</returns> [DllImport("kernel32.dll")] private static extern bool WriteConsole( IntPtr hConsoleOutput, string lpBuffer, uint nNumberOfCharsToWrite, out uint lpNumberOfCharsWritten, IntPtr lpReserved); /// <summary> /// The AllocConsole function allocates a new console for the calling process. /// </summary> /// <returns>If the function succeeds, the return value is nonzero.</returns> [DllImport("kernel32.dll")] private static extern Boolean AllocConsole(); /// <summary> /// The SetConsoleTitle function sets the title for the current console window. /// </summary> /// <param name="lpConsoleTitle">Pointer to a null-terminated string that contains /// the string to be displayed in the title bar of the console window.</param> /// <returns>If the function succeeds, the return value is nonzero.</returns> [DllImport("kernel32.dll")] private static extern bool SetConsoleTitle(string lpConsoleTitle); /// <summary> /// The GetStdHandle function retrieves a handle for the standard input, /// standard output, or standard error device. /// </summary> /// <param name="nStdHandle">Standard device for which a handle is to be returned.</param> /// <returns>If the function succeeds, the return value is a handle to the specified device, /// or a redirected handle set by a previous call to SetStdHandle</returns> [DllImport("kernel32.dll")] private static extern IntPtr GetStdHandle(int nStdHandle); /// <summary> /// The SetConsoleTextAttribute function sets the attributes of characters written to the console screen /// buffer by the WriteFile or WriteConsole function, or echoed by the ReadFile or ReadConsole function. /// This function affects text written after the function call. /// </summary> /// <param name="hConsoleOutput">Handle to a console screen buffer.</param> /// <param name="wAttributes">Character attributes.</param> /// <returns>If the function succeeds, the return value is nonzero.</returns> [DllImport("kernel32.dll", SetLastError=true)] private static extern bool SetConsoleTextAttribute(IntPtr hConsoleOutput, ConsoleAttributes wAttributes); /// <summary> /// The FreeConsole function detaches the calling process from its console. /// </summary> /// <returns>If the function succeeds, the return value is nonzero.</returns> [DllImport("kernel32.dll", SetLastError=true)] private static extern int FreeConsole(); #endregion Console API Imports #region Constructors /// <summary> /// Default constructor /// </summary> private ConsoleLib() { // Intentionally blank } #endregion Constructors #region Public Methods /// <summary> /// Sets the specified attribute for the standard output displayed on a console window. /// </summary> /// <param name="attributes">The console attributes to set.</param> public static void SetAttribute( ConsoleAttributes attributes ) { // Get std output handle IntPtr hOut = GetStdHandle(STD_OUTPUT_HANDLE); if ( hOut != IntPtr.Zero ) { // Set attribute SetConsoleTextAttribute( hOut, attributes); } } /// <summary> /// Returns true if the process has a standard output console window attached to it. /// </summary> public static bool HasConsole() { // Check if the std output handle exists return GetStdHandle(STD_OUTPUT_HANDLE) != IntPtr.Zero; } /// <summary> /// Closes the console window associated with this application. /// </summary> /// <returns>Returns true on success, else false.</returns> public static bool ExitConsole() { return FreeConsole() != 0; } /// <summary> /// Creates a console window. /// </summary> /// <returns>Returns true on success, else false.</returns> public static bool CreateConsole() { return AllocConsole(); } /// <summary> /// Sets the specified attribute for the standard output displayed on a console window. /// </summary> /// <param name="text">The text to write to the console window.</param> /// <param name="attributes">The console attributes to set.</param> public static void WriteFormatted( string text, ConsoleAttributes attributes ) { // Set attributes SetAttribute( attributes ); // Write text WriteLine( text ); // Clear attributes SetAttribute( (ConsoleAttributes)0 ); } /// <summary> /// Sets the console window title. /// </summary> /// <param name="title">The title of the console window.</param> public static void SetTitle( string title ) { // Set title SetConsoleTitle( title); } /// <summary> /// Writes a character string to a console screen buffer beginning at the current cursor location. /// </summary> /// <param name="text">The text to be written to the console screen buffer.</param> /// <returns>Returns true on success, else false.</returns> public static bool WriteLine( string text ) { return Write( text + Environment.NewLine ); } /// <summary> /// Writes a character string to a console screen buffer beginning at the current cursor location. /// </summary> /// <param name="text">The text to be written to the console screen buffer.</param> /// <returns>Returns true on success, else false.</returns> public static bool Write( string text ) { if ( text == null ) { return false; } // Get std output handle IntPtr hOut = GetStdHandle(STD_OUTPUT_HANDLE); if ( hOut != IntPtr.Zero ) { uint ignore; return WriteConsole( hOut , text, (uint)text.Length, out ignore, IntPtr.Zero ); } return false; } /// <summary> /// Reads the next line of characters from the standard input stream. /// </summary> /// <returns>Returns the next line of characters from the standard input stream.</returns> public static string ReadLine() { // Just delegate the call (as the Console class doesn't cache the std out handle) return Console.ReadLine(); } #endregion Public Methods }
Terms and Conditions
Support this site
Download a trial version of the best FTP application on the internet
