Skip to content
ConsoleMonster
Class

CommandLineHelpFluent

ConsoleMonster.Help

Namespace
ConsoleMonster.Help
Assembly
ConsoleMonster
Modifiers
static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of CommandLineHelp, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • CommandLineHelpFluent

Methods

public static CommandLineHelp AddCommand(CommandLineHelp commandLineHelp, HelpCommand item) #

Adds an item to CommandLineHelp.Commands: Commands in display order, optionally grouped or collapsed by the host.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
item ConsoleMonster.Help.HelpCommand required
The item.

Returns

CommandLineHelp The same instance.
AddCommands 2 overloads
public static CommandLineHelp AddCommands(CommandLineHelp commandLineHelp, params HelpCommand[] items) #

Adds items to CommandLineHelp.Commands: Commands in display order, optionally grouped or collapsed by the host.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
items ConsoleMonster.Help.HelpCommand[] required
The items, in order.

Returns

CommandLineHelp The same instance.
public static CommandLineHelp AddCommands(CommandLineHelp commandLineHelp, IEnumerable<HelpCommand> items) #

Adds items to CommandLineHelp.Commands: Commands in display order, optionally grouped or collapsed by the host.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpCommand> required
The items, in order.

Returns

CommandLineHelp The same instance.
public static CommandLineHelp AddValue(CommandLineHelp commandLineHelp, HelpValue item) #

Adds an item to CommandLineHelp.Values: Named positional values described independently of subcommands.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
item ConsoleMonster.Help.HelpValue required
The item.

Returns

CommandLineHelp The same instance.
AddValues 2 overloads
public static CommandLineHelp AddValues(CommandLineHelp commandLineHelp, params HelpValue[] items) #

Adds items to CommandLineHelp.Values: Named positional values described independently of subcommands.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
items ConsoleMonster.Help.HelpValue[] required
The items, in order.

Returns

CommandLineHelp The same instance.
public static CommandLineHelp AddValues(CommandLineHelp commandLineHelp, IEnumerable<HelpValue> items) #

Adds items to CommandLineHelp.Values: Named positional values described independently of subcommands.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpValue> required
The items, in order.

Returns

CommandLineHelp The same instance.
public static CommandLineHelp WithUsage(CommandLineHelp commandLineHelp, string value) #

Sets CommandLineHelp.Usage: The concise usage, including the executable name and positional placeholders.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
value string required
The value.

Returns

CommandLineHelp The same instance.
public static CommandLineHelp WithValuesHeading(CommandLineHelp commandLineHelp, string? value) #

Sets CommandLineHelp.ValuesHeading: Heading for a catalog of positional values, or null for the render profile's localized heading.

Parameters

commandLineHelp ConsoleMonster.Help.CommandLineHelp required
The instance.
value string? required
The value.

Returns

CommandLineHelp The same instance.