Table of Contents

CliTheme Class

Definition

Namespace
DotMake.CommandLine
Assembly
DotMake.CommandLine.dll

Represents the theme used by the Cli. These color and formatting option are mainly used by the help output.

public class CliTheme
Inheritance
CliTheme

Constructors

CliTheme()

Initializes a new instance of the CliTheme class.

CliTheme(CliTheme)

Initializes a new instance of the CliTheme class with a base theme to override.

Properties

Blue

Gets the Blue theme.

DarkBlue

Gets the Dark Blue theme.

DarkGreen

Gets the Dark Green theme.

DarkRed

Gets the Dark Red theme.

Default

Gets the default theme.

DefaultBgColor

Gets or sets the default background color used by the app.

Default is null, which is equivalent to Black on Windows and is equivalent to (ConsoleColor)-1 (unset/unknown) on Unix-like platforms.

DefaultColor

Gets or sets the default color used by the app.

Default is null, which is equivalent to Gray on Windows and is equivalent to (ConsoleColor)-1 (unset/unknown) on Unix-like platforms.

FirstColumnColor

Gets or sets the color used for a first column in help output.

Default is null which also means DefaultColor.

First column is similar to:

<argument-1>

-o, --option-1 <option-1>
-v, --version
-?, -h, --help

sub-command
Green

Gets the Green theme.

HeadingCasing

Gets or sets the casing used for a heading in help output.

Default is None.

For example, uppercase heading is similar to:

USAGE:
ARGUMENTS:
OPTIONS:
COMMANDS:
HeadingColor

Gets or sets the color used for a heading in help output.

Default is null which also means DefaultColor.

Heading is similar to:

Usage:
Arguments:
Options:
Commands:
HeadingNoColon

Gets or sets whether colon character at the end, is used for a heading in help output.

Default is false.

For example, no colon and uppercase heading is similar to:

USAGE
ARGUMENTS
OPTIONS
COMMANDS
NoColor

Gets the no-color theme.

Red

Gets the Red theme.

SecondColumnColor

Gets or sets the color used for a second column in help output.

Default is null which also means DefaultColor.

Second column is similar to:

Description for Argument1 [required]

Description for Option1 [default: DefaultForOption1]
Show version information
Show help and usage information

A nested level 1 sub-command
SynopsisColor

Gets or sets the color used for the synopsis section in help output.

Default is null which also means DefaultColor.

Synopsis section is similar to:

DotMake Command-Line TestApp v1.6.0
Copyright © 2023-2024 DotMake

A root cli command with nested children