XConsole.NET 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package XConsole.NET --version 1.0.0
NuGet\Install-Package XConsole.NET -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="XConsole.NET" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add XConsole.NET --version 1.0.0
#r "nuget: XConsole.NET, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install XConsole.NET as a Cake Addin
#addin nuget:?package=XConsole.NET&version=1.0.0

// Install XConsole.NET as a Cake Tool
#tool nuget:?package=XConsole.NET&version=1.0.0

Using XConsole:

  1. Add reference to XConsole DLL if not added automatically by NuGet
  2. Import the namespace XConsoleNET
using XConsoleNET;
  1. Use the following code to initialize your XConsole app (this is a demo code and not all properties of XSettings are needed)
		XConsole.Init(new XSettings
            {
                BackgroundColor = System.ConsoleColor.White,
                ForegroundColor = System.ConsoleColor.Black,
                ErrorBackgroundColor = System.ConsoleColor.Yellow,
                ErrorForegroundColor = System.ConsoleColor.Red,
                ExitCommand = new XCommand() { Command = "exit", Delimiter = ' ' },
                HelpCommand = new XCommand() { Command = "help", Delimiter = ' ' },
                HistoryCommand = new XCommand() { Command = "hist", Delimiter = ' ' },
                WelcomeMessage = "Hello my app",
                Commands = new System.Collections.Generic.List<XCommand>
                {
                    new XCommand { Command = "nq", Delimiter = ' ', ParametersCount = 1, Description = "A command to enqueue a value selected by user. ex {nq 10}" },
                    new XCommand { Command = "dq", Delimiter = ' ', ParametersCount = 0, Description= "A command to dequeue the next value from q"},
                },
            });
  1. Handle CommandFired event as follows:
        XConsole.CommandFired += XConsole_CommandFired;
  1. The handler method should be something like that
        private static void XConsole_CommandFired(XConsoleNET.Events.XEventArgs e)
        {
            if (e.Command == null)
            {
                XConsole.Write("Bad Command");
                return;
            }
            switch (e.Command.Command)
            {
                case "nq":
                    XConsole.Write($"Enqueueing value : {e.Command.Parameters.FirstOrDefault()}");
                    break;

                case "dq":
                    XConsole.Write($"Dequeuing the next value");
                    break;
                default:
                    break;
            }
        }
  1. Call RunProgram to start your program in console
        XConsole.RunProgram();
Your program can display help by typing "help" (as default) and will terminate by typing "exit" (by default)

enjoy...

Product Compatible and additional computed target framework versions.
.NET Framework net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 618 5/20/2019
1.0.0 576 3/31/2019

Release 1.0