Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.41 KB

readme.md

File metadata and controls

32 lines (21 loc) · 1.41 KB

J4JCommandLine: Colorful Help

This extension library adds the ability to display help information from within J4JCommandLine in a colorful and neatly formatted way.

Nuget

The libraries are licensed under the GNU GPL-v3 or later. For more details see the license file.

See the change log for a history of significant changes.

Usage

You use the extension by passing a new instance of ColorHelpDisplay() to the DisplayHelp() method::

options.DisplayHelp( new ColorHelpDisplay() );

That gets you a display which looks like this:

fancy help

DisplayColorHelp offers a few properties you can use to tweak the display:

Property What It Does
CellPadding Sets the padding within each cell of the table. The default is two spaces horizontally and no spaces vertically.
HeadingColor Sets the color of the column headers. The default is green.
TitleColor Sets the color for the help title. The default is yellow.
EmphasisColor Sets the color used for emphasizing text such as keys. The default is cyan.
TextColor Sets the color used for basic text. The default is white.
GridColor Sets the color for the table grid. The default is gray.