Command Line Helper

Description

CommandLineHelper is a utility class in WinForms Controls created to parse command line arguments for Windows Forms application easily. The purpose of command line for WinForms application is used to launch application with user selected configuration.

To make it more user friendly, a built in Command Line Builder Dialog is available to help user to create command line using the available options, create batch file as well as create window's shortcut.


Arguments and Switches

Command line parameters are categorized as arguments and switches where argument are mandatory parameter while switches on the other hand are optional parameter. Arguments and switches are registered to application by developer using AddArgument and AddSwitch functions.

Switches normally use as an true or false logic. An optional variable can be added to define quantitative value, for example: /T:time

Usage

Initialization

  1. Create a new instance
    CommandLineHelper cmdLine = new CommandLineHelper("Description");
  2.  Register command line argument and switches
    cmdLine.AddArgument("Source Path", "Source Folder Path");
    cmdLine.AddSwitch("/MIN", "Minimize Window");
    cmdLine.AddSwitch("/T", "Delay(ms)", "t");

Parse Command Line

Call cmdLine.ParseCommandLine() to parse command line arguments in constructor of main form or Shown event. The function will return TRUE if the command line is valid.

With valid command line input, value for each argument can be retrieve by the following functions:
  string sourcePath = cmdLine.GetArgumentValue("Source Path");
  bool minWindow = cmdLine.IsSwitchSet("/MIN");
  int delay = Convert.ToInt32(cmdLine.GetSwitchValue("/T", "100"));

Build Command Line - Programmatically

To create or update command line programmatically using the current application settings, set value for each argument and switches with following functions:
  • cmdLine.SetArgument("Source Path", "C:\\Target\\");
  • cmdLine.ClearSwitch("/MIN");
  • cmdLine.SetSwitch("/T", "20");
Then, generate the complete command line as follow:
  string output = cmdLine.BuildCommandLine(); 

 Command Line Builder - Interactive

Command line can also be created by user using the interactive Command Line Builder Dialog. The dialog is created to assist user to fill in the value for each arguments and select option for each switches when building command line. The generated command line can be copy to clipboard, output a batch file or even create as Window's shortcut.

  cmdLine.ShowDialog();

 Updates


  • Introduced multiple choice switch, can be added from CommandLineHelper using method:
    public void AddSwitch(string name, string description, string[] options)





Download CommandLineHelper from WinForms Controls.

Popular posts from this blog

WinForms Gauge Control

Image
Introduction WinForm Gauge - Released 2021   WinForm Gauge is successor for AGauge control, redesigned with better structure, performance and features. Find out more  at https://winformgauge.codearteng.com/     Original AGauge control AGauge is a gauge control for WinForms create by A.J.Bauer using GDI+. Original code was published in " Code Project - A fast and performing gauge " The version that I published here is an improved version of AGauge which contains the following changes. Download from GitHub   NOTE: We no longer actively maintaining AGauge. The development of this package is taken over by nutdotnet . Refer to his GitHub and NuGet page for details.   Improvements   Dynamic Gauge Label and Gauge Range Properties for gauge label (previously known as CapText ) and range are grouped into GaugeRanges and GaugeLabels which allow us to create any number of range and label ...
Read more

WinForms Controls

Image
Description Collection of .NET Windows Forms controls for WinForms application. Named as CodeArtEng.Controls.dll Download GitHub NuGet Features  Command Line Helper Labeled Text Box Hinted Text Box Multi-Line Button Status Label Open File Panel and Folder Browse Panel MRU (Most Recent Used File List) File Explorer Control Quick Access List Rich Text Box Editor Features Description Command Macro Editor Input editing dialog inspired by Visual Studio "Edit Pre-Build" and "Edit Post-Build" Dialog... ( Learn More... ) Command Line Helper Generate and parse command line with command line helper. ( Learn More... ) Labeled Text Box  Text box with label and hint, derived from Hinted Text Box. Hinted Text Box  Enhanced version of WinForms TextBox with capability to show hint in gray color text. Multi-Line Button  Button control with optional image and 2 lines of text, main and sub title. Each line can be configured using d...
Read more

C# DSP Simulation - DSP Lab

Image
Introduction DSP Lab  is a digital signal processing simulation application created to simulate and visualize process of sampling and filtering analog signal using DSP system. This application is created to provide as a tool for educator and student to have a better understanding how DSP system works. DSP Lab allow you to view and listen to output from (Data Acquisition Unit) DAQ and digital filters. DSP Toolbox is the core of DSP Lab application which is a .NET assembly written in C#. The library is released under MIT license. You can use this library to jump start your own DSP powered application. DSP System DSP Lab is built using the system as shown above. Settings for each components are configurable. In PREMIUM  version, a 3 channels mixer system is available for more fun and signal combinations.
Read more