Console class, if anyone wants it

Printable View

I couldn't find a compelete console class for VB, and most of the good ones are in C#. So I just converted some code to vb.net to add it to my library. It's mainly from a project called ExtendedConsole which is written in C#. But I made some changed.... and I think I combined some other programs from C# and VB6 to make this:D
Also see the next post for the rest of the code

VB Code:

' Please do not remove :)
' Written by Kourosh Derakshan
'
Option Strict On
Imports System.Runtime.InteropServices
Imports System.Text
 
Public NotInheritable Class ConsoleEx
#Region " Declarations "
        Private hConsoleIn, hConsoleOut As IntPtr
        Private conInfo As Win32Native.CONSOLE_INFO
        Private cursorInfo As Win32Native.CURSOR_INFO
        Private backColor As Integer
        Private backgroundAttrib As Short
 
 
        Enum InputMode
            LineInput
            EchoInput
        End Enum
 
        Public Enum ConsoleColor
            Black = 0
            Blue = Win32Native.FOREGROUND_BLUE
            Green = Win32Native.FOREGROUND_GREEN
 
            SkyBlue = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_GREEN
 
            Red = Win32Native.FOREGROUND_RED
            Purple = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_RED
            Brown = Win32Native.FOREGROUND_GREEN + Win32Native.FOREGROUND_RED
            White = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_GREEN + _
                    Win32Native.FOREGROUND_RED
            Gray = Win32Native.FOREGROUND_INTENSIFY
            BlueForte = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_INTENSIFY
            GreenForte = Win32Native.FOREGROUND_GREEN + Win32Native.FOREGROUND_INTENSIFY
            SkyBlueForte = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_GREEN + _
                           Win32Native.FOREGROUND_INTENSIFY
            RedForte = Win32Native.FOREGROUND_RED + Win32Native.FOREGROUND_INTENSIFY
            PurpleForte = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_RED + _
            Win32Native.FOREGROUND_INTENSIFY
            Yellow = Win32Native.FOREGROUND_GREEN + Win32Native.FOREGROUND_RED + _
            Win32Native.FOREGROUND_INTENSIFY
            WhiteForte = Win32Native.FOREGROUND_BLUE + Win32Native.FOREGROUND_GREEN + _
                         Win32Native.FOREGROUND_RED + Win32Native.FOREGROUND_INTENSIFY
        End Enum
 
        Public Enum CursorType
            Off
            SingleLine
            Block
        End Enum
#End Region
 
        Public Sub New()
            ' Creates a console if there isn't already one loaded.
            Win32Native.AllocConsole()
 
            ' Set the input handle
            hConsoleIn = Win32Native.GetStdHandle(Win32Native.STD_INPUT_HANDLE)
            ' Set the output handle
            hConsoleOut = Win32Native.GetStdHandle(Win32Native.STD_OUTPUT_HANDLE)
 
 
            ' Fill in the console information to conInfo
            conInfo = New Win32Native.CONSOLE_INFO
            updateConsoleInfo()
 
            ' Fill in the cursor information for this console
            cursorInfo = New Win32Native.CURSOR_INFO
            SetCursorType(CursorType.SingleLine)
 
            ' Set the standard background attribute
            backgroundAttrib = CShort((CShort(ConsoleColor.Black) * &H10 + CShort(ConsoleColor.White)))
        End Sub
 
        Protected Overrides Sub Finalize()
            MyBase.Finalize()
            FreeConsole()
        End Sub
 
        Public Property Title() As String
            Get
                Dim buffer As New StringBuilder(128)
                Win32Native.GetConsoleTitle(buffer, 128)
                Return buffer.ToString
            End Get
 
            Set(ByVal Value As String)
                Win32Native.SetConsoleTitle(Value)
            End Set
        End Property
 
        Public ReadOnly Property Columns() As Integer
            Get
                Return conInfo.MaxSize.x
            End Get
        End Property
 
        Public ReadOnly Property Rows() As Integer
            Get
                Return conInfo.MaxSize.y
            End Get
        End Property
 
        ' X position of the cursor (or the carret) on the screen
        Public ReadOnly Property CursorX() As Integer
            Get
                updateConsoleInfo()
                Return conInfo.CursorPosition.x
            End Get
        End Property
 
        ' Y position of the cursor (or the carret) on the screen
        Public ReadOnly Property CursorY() As Integer
            Get
                updateConsoleInfo()
                Return conInfo.CursorPosition.y
            End Get
        End Property
 
        ' LineInput will let the console read a line at a time. EchoInput lets the console
        ' read each key stroke, as the user types something (You have to use Console.Read ()
        ' instead of Console.ReadLine() when in EchoInput.)
        Public Sub SetMode(ByVal mode As InputMode)
            Dim conMode As Integer
            Win32Native.GetConsoleMode(hConsoleIn, conMode)
 
            If mode = InputMode.EchoInput Then
                conMode = conMode And Not (Win32Native.ENABLE_LINE_INPUT Or Win32Native.ENABLE_ECHO_INPUT)
            Else
                conMode = conMode Or (Win32Native.ENABLE_LINE_INPUT Or Win32Native.ENABLE_ECHO_INPUT)
            End If
            Win32Native.SetConsoleMode(hConsoleIn, conMode)
        End Sub
 
        Public Sub Clear()
            Dim written As Integer = 0
            Dim startCoord As New Win32Native.COORD
            startCoord.x = 0 : startCoord.y = 0
 
            Win32Native.FillConsoleOutputCharacter(hConsoleOut, " "c, conInfo.MaxSize.x * conInfo.MaxSize.y, startCoord, written)
            Win32Native.FillConsoleOutputAttribute(hConsoleOut, backgroundAttrib, conInfo.MaxSize.x * conInfo.MaxSize.y, startCoord, written)
 
            MoveCursor(1, 1)
        End Sub
 
        ' Use only if the console is in LineInput mode. If value is true, then the things
        ' that the user types will automatically show up in the console. (In EchoInput mode
        ' nothing shows up automatically)
        Public Sub EchoInput(ByVal value As Boolean)
            Dim Ret As Integer
            Win32Native.GetConsoleMode(hConsoleIn, Ret)
            If value Then
                Ret = Ret Or (Win32Native.ENABLE_ECHO_INPUT)
            Else
                Ret = Ret And Not (Win32Native.ENABLE_ECHO_INPUT)
            End If
            Win32Native.SetConsoleMode(hConsoleIn, Ret)
        End Sub
 
        Public Sub SetColor(ByVal foreColor As ConsoleColor, ByVal backColor As ConsoleColor)
            Me.backColor = CInt(backColor)
            SetColor(foreColor)
        End Sub
 
        Public Sub SetColor(ByVal foreColor As ConsoleColor)
            Win32Native.SetConsoleTextAttribute(hConsoleOut, CInt(foreColor) + 16 * backColor)
        End Sub
 
        Public Sub SetClsColor(ByVal backColor As ConsoleColor)
               backgroundAttrib = CShort(backColor) * &H10S
        End Sub
 
        Public Sub MoveCursor(ByVal x As Integer, ByVal y As Integer)
            conInfo.CursorPosition.x = CShort(x - 1)
            conInfo.CursorPosition.y = CShort(y - 1)
            If cursorInfo.Visible Then
                Dim coord As Integer = conInfo.CursorPosition.x + conInfo.CursorPosition.y * &H10000
                Win32Native.SetConsoleCursorPosition(hConsoleOut, coord)
            End If
        End Sub
 
 
        ' Change the cursor's shape and visibility state.
        Public Sub SetCursorType(ByVal newType As CursorType)
            '  Change the cursor type.
            Select Case newType
                Case CursorType.Block
                    cursorInfo.Size = 100
                    cursorInfo.Visible = True
 
                Case CursorType.SingleLine
                    cursorInfo.Size = 10
                    cursorInfo.Visible = True
 
                Case CursorType.Off
                    cursorInfo.Size = 100
                    cursorInfo.Visible = False
            End Select
 
            Win32Native.SetConsoleCursorInfo(hConsoleOut, cursorInfo)
 
            ' Move the cursor to its correct position.
            MoveCursor(conInfo.CursorPosition.x, conInfo.CursorPosition.y)
        End Sub
 
        ' Forces to close the console. Don't call if not necessary.
        Public Sub FreeConsole()
            ' I just added these myself. I don't if I really have to do this, but I thought
            ' they are necessary. That's why it's in a Try-Catch block, because I don't
            ' know if it may cause an error or not. But it shouldn't.
            Try
                Win32Native.FreeConsole()
                Win32Native.CloseHandle(hConsoleIn)
                Win32Native.CloseHandle(hConsoleOut)
                Win32Native.FreeConsole()
            Catch
            End Try
        End Sub
 
 
        Private Sub updateConsoleInfo()
            ' Fill in the console information to conInfo
            Win32Native.GetConsoleScreenBufferInfo(hConsoleOut, conInfo)
        End Sub
    End Class

and this class is used by the above class:

VB Code:

' Please do not remove :)
' Written by Kourosh Derakshan
'
  Friend Class Win32Native
        ' Input and output handle 
        Friend Const STD_OUTPUT_HANDLE As Integer = -11&
        Friend Const STD_INPUT_HANDLE As Integer = -10&
        ' Echo Input would let the program to receive each key stroke.
        Friend Const ENABLE_LINE_INPUT As Short = &H2S
        Friend Const ENABLE_ECHO_INPUT As Short = &H4S
 
        ' Color codes
        Friend Const FOREGROUND_BLUE As Integer = &H1&
        Friend Const FOREGROUND_GREEN As Integer = &H2&
        Friend Const FOREGROUND_RED As Integer = &H4&
        Friend Const FOREGROUND_INTENSIFY As Integer = &H8&
        Friend Const BACKGROUND_BLUE As Integer = &H10&
        Friend Const BACKGROUND_GREEN As Integer = &H20&
        Friend Const BACKGROUND_INTENSIFY As Integer = &H80&
 
 
 
        Public Enum BACKGROUNDCOLOR
            bBLUE = &H10&   'BACKGROUND_BLUE
            bGREEN = &H20&  'BACKGROUND_GREEN
            bRED = &H40&    'BACKGROUND_RED
            bBRIGHT = &H80& 'BACKGROUND_INTENSITY
        End Enum
 
        <StructLayout(LayoutKind.Sequential)> _
        Friend Structure COORD
            Friend x, y As Short
        End Structure
 
        <StructLayout(LayoutKind.Sequential)> _
        Friend Structure RECT
            Dim Left, Top, Right, Bottom As Short
        End Structure
 
        <StructLayout(LayoutKind.Sequential)> _
        Friend Structure CONSOLE_INFO
            Friend Size As COORD
            Friend CursorPosition As COORD
            Friend Attribute As Short
            Friend Window As RECT
            Friend MaxSize As COORD
        End Structure
 
        <StructLayout(LayoutKind.Sequential)> _
        Friend Structure CURSOR_INFO
            Friend Size As Integer
            Friend Visible As Boolean
        End Structure
 
 
 
 
 
        <DllImport("kernel32")> _
               Public Shared Sub SetConsoleTitle(ByVal lpTitleStr As String)
        End Sub
 
        <DllImport("kernel32")> _
        Public Shared Sub GetConsoleTitle(ByVal lpBuff As StringBuilder, ByVal buffSize As Integer)
        End Sub
 
        <DllImport("kernel32")> _
               Public Shared Function SetConsoleTextAttribute(ByVal hConsoleOutput As IntPtr, ByVal wAttributes As Integer) As Integer
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Function FillConsoleOutputCharacter(ByVal Handle As IntPtr, ByVal uChar As Char, _
                                                          ByVal Len As Integer, ByVal start As COORD, ByRef written As Integer) As Integer
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Function FillConsoleOutputAttribute(ByVal Handle As IntPtr, ByVal att As Short, _
                                                          ByVal Len As Integer, ByVal start As COORD, _
                                                          ByRef writted As Integer) As Boolean
        End Function
 
 
        <DllImport("kernel32")> _
        Public Shared Sub GetConsoleScreenBufferInfo(ByVal Handle As IntPtr, _
                                                     ByRef info As CONSOLE_INFO)
        End Sub
 
        <DllImport("kernel32")> _
        Public Shared Function SetConsoleCursorInfo(ByVal Handle As IntPtr, ByRef info As CURSOR_INFO) As Boolean
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Function SetConsoleCursorPosition(ByVal handle As IntPtr, ByVal coord As Integer) As Boolean
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Function GetStdHandle(ByVal nStdHandle As Integer) As IntPtr
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Sub GetConsoleMode(ByVal hConsoleHandle As IntPtr, ByRef lpMode As Integer)
        End Sub
 
        <DllImport("kernel32")> _
        Public Shared Sub SetConsoleMode(ByVal hConsoleHandle As IntPtr, ByVal dwMode As Integer)
        End Sub
 
        <DllImport("kernel32")> _
        Public Shared Function CloseHandle(ByVal hObject As IntPtr) As Integer
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Function AllocConsole() As Integer
        End Function
 
        <DllImport("kernel32")> _
        Public Shared Function FreeConsole() As Integer
        End Function
 
    End Class

May 25th, 2003, 01:51 PM
MrPolite

Btw is there a way to create a console in a windows forms project, using the default System.Console class?
May 25th, 2003, 04:27 PM
Pirate

What benefit would someone gets from this code ??:D
May 25th, 2003, 04:46 PM
MrPolite

Quote:

Originally posted by Pirate
What benefit would someone gets from this code ??:D

Lets you:
-change the foreground or background color of the text
-change the background color of the console (call SetCLSColor, and then the Clear function)
-Change or read the title of the console
-clear a console window
-change the input mode of the console (call SetMode - whether it should read the input line by line, or to read every key stroke one by one)
-move the cursor to any random position
-enable/disable showing what the user types in the console ( call EchoInput )
-get the size of the console window (number of columns and rows)
-get the current position of the cursor
-change the cursor type (the carret)
-close the console whenever you want (FreeConsole() )
-create a console by calling this class (althought it doesnt let you read/write.... it may not be necessary if someone can answer my previous post in this thread)

only one of these is enough reason for me to use this class. You don't have to use this instead of the Console class. In a console app, you just define an instance of this class and you can use it as a "tool". I dont know, but if it's necessary I can add the Read/Readline/Write functions to it and make it like a stand-alone console so you wouldn't need the system.console at all. I just need to know if it's possible to create a System.Console window in a windows forms project (and I believe it should be)
May 25th, 2003, 04:55 PM
Pirate

Wow that should be awesome ! maybe I can't help you here , but thanks for sharing !:D
May 25th, 2003, 05:36 PM
MrPolite
aah forgot a peice.... added a new function. Lets you change the background color of the console as well as the background color of the text.
VB Code:
```
Public Sub SetClsColor(ByVal backColor As ConsoleColor)
            backgroundAttrib = CShort(backColor) * &H10S
  End Sub
```
You call this and choose a backcolor, and then you call the Clear function. It will change the backcolor of the console.
What I don't understand is that the C# version of this function received a backcolor AND a forecolor, while the forecolor seems quite useless (since it doesnt affect the text color). So I just removed the forecolor from the function. In case I'm wrong, here's the original function:
VB Code:
```
static public void SetClsColor(ConsoleColor back, ConsoleColor fore)
        {
            m_BackAtt = (short)(((short) back) * 0x10 + (short) fore);
        }
```
Jun 14th, 2003, 10:31 PM
wayneh

Mr Polite -

Would you be willing to upload a small sample of how to use this code?

Thanks.
Jun 15th, 2003, 08:03 AM
Tygur

Quote:

Originally posted by MrPolite
Btw is there a way to create a console in a windows forms project, using the default System.Console class?

At first glance, it looks like you can't. It looks like, in a windows forms project, you have to use api calls, even to write to the console, and you probably have to call the AllocConsole API to make a console window for your process first. Maybe I'll test this further later, but that's how it looks.

Right now, I don't have much time, but I do know how to use the console api functions, if you need help, as I had to write a similar class like this for myself, which actually does far more than this one you posted does..
Jun 22nd, 2003, 03:18 AM
MrPolite

Quote:

Originally posted by wayneh
Mr Polite -

Would you be willing to upload a small sample of how to use this code?

Thanks.

sorry I ignored you for a while:D I made a little sample

Console Sample

and here's the code of it, if you dont wanna download it.... put this in a console project, as sub main. Put the consoleEx class and Win32Native in the project also

VB Code:

Module Module1
 
 
    Sub Main()
        Dim conEx As New ConsoleEx
 
        Console.WriteLine("Hello world... changing the title")
        conEx.Title = "New Title!"
        Console.WriteLine("The new title is: " & conEx.Title)
        Console.WriteLine()
 
 
 
 
 
 
        Console.WriteLine("Type something. Everything will be shown in upper-case. Press enter to stop:")
        ' Change the input mode to receive every key stroke
        conEx.SetMode(ConsoleEx.InputMode.EchoInput)
        Do
            Dim asciiCode As Integer
            Dim aChar As Char
 
            ' Note that I'm not calling the Readline method, I'm calling the Read method in this mode
            asciiCode = CInt(Console.Read())  ' Returns the ascii code of the entered character
 
            ' 13 is the code for enter
            If asciiCode = 13 Then
                Exit Do
            End If
 
            ' Convert the asciicode to its character 
            aChar = Chr(asciiCode)
            aChar = Char.ToUpper(aChar)
 
            Console.Write(aChar)
        Loop
        Console.WriteLine()
        Console.WriteLine("Press anykey to clear the screen...")
        Console.Read()
 
        ' Change back the input-mode to line input
        conEx.SetMode(ConsoleEx.InputMode.LineInput)
        conEx.Clear()
 
 
 
 
 
 
        conEx.SetCursorType(ConsoleEx.CursorType.Off)
        Console.WriteLine("Cursor turned off ...")
        Console.ReadLine()
        Console.WriteLine()
 
        conEx.SetCursorType(ConsoleEx.CursorType.Block)
        Console.WriteLine("Block-type cursor...")
        Console.ReadLine()
        Console.WriteLine()
 
        Console.WriteLine("Cursor restored...")
        conEx.SetCursorType(ConsoleEx.CursorType.SingleLine)
        Console.ReadLine()
        conEx.Clear()
 
 
 
 
 
 
        Console.WriteLine("Turning off the echo, type something and press enter...")
        conEx.EchoInput(False)
        Dim tmpStr As String = Console.ReadLine()
        Console.WriteLine("You typed: " & tmpStr)
        conEx.EchoInput(True)
 
        conEx.SetMode(ConsoleEx.InputMode.EchoInput)
        Console.WriteLine("Press any key to continue...")
        Console.Read()
        conEx.SetMode(ConsoleEx.InputMode.LineInput)
        conEx.Clear()
 
 
 
 
 
        ' (1 is the smallest position, not 0)
        conEx.MoveCursor(1, 10)
        conEx.SetColor(ConsoleEx.ConsoleColor.Red)
        Console.WriteLine("RED")
        conEx.SetColor(ConsoleEx.ConsoleColor.Blue)
        Console.WriteLine("Type in blue: ")
        Console.ReadLine()
 
        ' Original color
        conEx.SetColor(ConsoleEx.ConsoleColor.White)
 
 
        conEx.SetMode(ConsoleEx.InputMode.EchoInput)
        Console.WriteLine("Press any key to continue...")
        Console.Read()
    End Sub
 
End Module

Jun 22nd, 2003, 09:09 AM
wayneh

Thanks for the upload, but I can't get any of it to work!

I don't use .NET - I use VB6.
Jun 22nd, 2003, 01:02 PM
PT Exorcist

then you shouldn't be watching this forum :eek: :confused:
Jun 22nd, 2003, 01:10 PM
wayneh

PT Exorcist:

1) I wasn't talking to you

2) I'm pretty sure there's no law against checking out any forum I wish

3) Were you born a jerk - or have you just grown into one?
Jun 22nd, 2003, 01:12 PM
MrPolite

Quote:

Originally posted by wayneh
Thanks for the upload, but I can't get any of it to work!

I don't use .NET - I use VB6.

heheh, you cant use it unless someone compiles it in a way to work with vb6, and I don't really know how they do that.... it's quit easy to find something like this written in vb6, I think
Jun 22nd, 2003, 01:25 PM
wayneh

Thanks anyway -

I'll still hang on to the code and see if I can use it.
Jun 22nd, 2003, 02:01 PM
MrPolite

Quote:

Originally posted by wayneh
Thanks anyway -

I'll still hang on to the code and see if I can use it.

hehe you do VB6 and you're trying to use the code, the people on the VB.NET forum do VB.NET and I don't think anyone has tried to use this yet:D:D

Good luck... Just in case you don't know, convert the integer datatypes to long if you wanna convert it to vb6
Jun 22nd, 2003, 02:35 PM
Pirate

Quote:

Originally posted by PT Exorcist
then you shouldn't be watching this forum :eek: :confused:

lol ...:D

wayneh , In order to run the project , you need the .NET Framework . It would be quite difficult to convert that to VB6 (since this proj is based on the base Console Class of .NET Framework) .
Jun 22nd, 2003, 02:47 PM
PT Exorcist

Quote:

Originally posted by wayneh
PT Exorcist:

1) I wasn't talking to you

2) I'm pretty sure there's no law against checking out any forum I wish

3) Were you born a jerk - or have you just grown into one?

of course u can watch this forum..but its more than obvious than a vb.net class wouldnt compile in vb6 as it is not totally oop..then asking for a way to use it (in vb.net) wasnt the smartest question to ask

ok u rule
Jun 24th, 2003, 07:00 PM
Iamthewalrus15

OMG that is so lame, the IDE wont even let me OPEN your project since im on 02 instead of 03.. rediculus
Jun 24th, 2003, 07:35 PM
Pirate

Quote:

Originally posted by Iamthewalrus15
OMG that is so lame, the IDE wont even let me OPEN your project since im on 02 instead of 03.. rediculus

Why don't you try the converter under my sig. It converts VS.NET 2003 Proj to VS.NET 2002 !
Jun 24th, 2003, 09:53 PM
MrPolite

Quote:

Originally posted by Iamthewalrus15
OMG that is so lame, the IDE wont even let me OPEN your project since im on 02 instead of 03.. rediculus

you dont really need to CONVERT it back... just start a new solution (console class), remove the main module and add the classes from my project
Aug 26th, 2003, 10:34 AM
MrPolite

1 Attachment(s)

uuh I'm just trying to upload some files for this post... you can safely ignore this:p
Aug 26th, 2003, 10:35 AM
MrPolite

1 Attachment(s)

dll file
Aug 26th, 2003, 10:35 AM
MrPolite

1 Attachment(s)

sample project
Jul 5th, 2004, 11:51 AM
jandyfischer

Do you have the C# version of the ConsoleEX that you posted?

I could re-write the C# version but if you have it, please post it
Jul 14th, 2004, 07:36 AM
Andy

hey man. that's a pretty neat sample. You obviousely put a lot of effort into this class. Good work man!!