Skip to content
ConsoleMonster
Class

HelpFluent

ConsoleMonster.Help

Namespace
ConsoleMonster.Help
Assembly
ConsoleMonster
Modifiers
static

The fluent methods of HelpTopic, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • HelpFluent

Methods

public static HelpParameter AddAliase(HelpParameter helpParameter, string item) #

Adds an item to HelpParameter.Aliases: The aliases, or empty.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
item string required
The item.

Returns

HelpParameter The same instance.
AddAliases 2 overloads
public static HelpParameter AddAliases(HelpParameter helpParameter, params string[] items) #

Adds items to HelpParameter.Aliases: The aliases, or empty.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
items string[] required
The items, in order.

Returns

HelpParameter The same instance.
public static HelpParameter AddAliases(HelpParameter helpParameter, IEnumerable<string> items) #

Adds items to HelpParameter.Aliases: The aliases, or empty.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

HelpParameter The same instance.
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.
AddDescription 3 overloads
public static HelpTopic AddDescription(HelpTopic helpTopic, string item) #

Adds an item to HelpTopic.Description: The description paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item string required
The item.

Returns

HelpTopic The same instance.
public static HelpTopic AddDescription(HelpTopic helpTopic, params string[] items) #

Adds items to HelpTopic.Description: The description paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items string[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddDescription(HelpTopic helpTopic, IEnumerable<string> items) #

Adds items to HelpTopic.Description: The description paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddExample(HelpTopic helpTopic, HelpExample item) #

Adds an item to HelpTopic.Examples: The examples.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item ConsoleMonster.Help.HelpExample required
The item.

Returns

HelpTopic The same instance.
AddExamples 2 overloads
public static HelpTopic AddExamples(HelpTopic helpTopic, params HelpExample[] items) #

Adds items to HelpTopic.Examples: The examples.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items ConsoleMonster.Help.HelpExample[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddExamples(HelpTopic helpTopic, IEnumerable<HelpExample> items) #

Adds items to HelpTopic.Examples: The examples.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpExample> required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddInput(HelpTopic helpTopic, string item) #

Adds an item to HelpTopic.Inputs: The input types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item string required
The item.

Returns

HelpTopic The same instance.
AddInputs 2 overloads
public static HelpTopic AddInputs(HelpTopic helpTopic, params string[] items) #

Adds items to HelpTopic.Inputs: The input types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items string[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddInputs(HelpTopic helpTopic, IEnumerable<string> items) #

Adds items to HelpTopic.Inputs: The input types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

HelpTopic The same instance.
AddLinks 2 overloads
public static HelpTopic AddNote(HelpTopic helpTopic, string item) #

Adds an item to HelpTopic.Notes: The notes paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item string required
The item.

Returns

HelpTopic The same instance.
AddNotes 2 overloads
public static HelpTopic AddNotes(HelpTopic helpTopic, params string[] items) #

Adds items to HelpTopic.Notes: The notes paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items string[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddNotes(HelpTopic helpTopic, IEnumerable<string> items) #

Adds items to HelpTopic.Notes: The notes paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddOutput(HelpTopic helpTopic, string item) #

Adds an item to HelpTopic.Outputs: The output types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item string required
The item.

Returns

HelpTopic The same instance.
AddOutputs 2 overloads
public static HelpTopic AddOutputs(HelpTopic helpTopic, params string[] items) #

Adds items to HelpTopic.Outputs: The output types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items string[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddOutputs(HelpTopic helpTopic, IEnumerable<string> items) #

Adds items to HelpTopic.Outputs: The output types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

HelpTopic The same instance.
AddParameter 2 overloads
public static HelpTopic AddParameter(HelpTopic helpTopic, HelpParameter item) #

Adds an item to HelpTopic.Parameters: The parameters, in help order.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item ConsoleMonster.Help.HelpParameter required
The item.

Returns

HelpTopic The same instance.
public static HelpSyntax AddParameter(HelpSyntax helpSyntax, HelpSyntaxParameter item) #

Adds an item to HelpSyntax.Parameters: The parameters.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax required
The instance.
item ConsoleMonster.Help.HelpSyntaxParameter required
The item.

Returns

HelpSyntax The same instance.
AddParameters 4 overloads
public static HelpTopic AddParameters(HelpTopic helpTopic, params HelpParameter[] items) #

Adds items to HelpTopic.Parameters: The parameters, in help order.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items ConsoleMonster.Help.HelpParameter[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddParameters(HelpTopic helpTopic, IEnumerable<HelpParameter> items) #

Adds items to HelpTopic.Parameters: The parameters, in help order.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpParameter> required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpSyntax AddParameters(HelpSyntax helpSyntax, params HelpSyntaxParameter[] items) #

Adds items to HelpSyntax.Parameters: The parameters.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax required
The instance.
items ConsoleMonster.Help.HelpSyntaxParameter[] required
The items, in order.

Returns

HelpSyntax The same instance.
public static HelpSyntax AddParameters(HelpSyntax helpSyntax, IEnumerable<HelpSyntaxParameter> items) #

Adds items to HelpSyntax.Parameters: The parameters.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntaxParameter> required
The items, in order.

Returns

HelpSyntax The same instance.
AddSyntax 3 overloads
public static HelpTopic AddSyntax(HelpTopic helpTopic, HelpSyntax item) #

Adds an item to HelpTopic.Syntax: One syntax per parameter set.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
item ConsoleMonster.Help.HelpSyntax required
The item.

Returns

HelpTopic The same instance.
public static HelpTopic AddSyntax(HelpTopic helpTopic, params HelpSyntax[] items) #

Adds items to HelpTopic.Syntax: One syntax per parameter set.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items ConsoleMonster.Help.HelpSyntax[] required
The items, in order.

Returns

HelpTopic The same instance.
public static HelpTopic AddSyntax(HelpTopic helpTopic, IEnumerable<HelpSyntax> items) #

Adds items to HelpTopic.Syntax: One syntax per parameter set.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntax> required
The items, in order.

Returns

HelpTopic 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.
CommandLine 2 overloads
public static HelpTopic CommandLine(HelpTopic helpTopic, CommandLineHelp? value) #

Sets HelpTopic.CommandLine: Optional compact command-line layout; null retains the PowerShell help layout.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
value ConsoleMonster.Help.CommandLineHelp? required
The value.

Returns

HelpTopic The same instance.

Examples

// C# initializer or property     // C# fluent
helpTopic.CommandLine = value;    helpTopic.CommandLine(value);
public static HelpTopic CommandLine(HelpTopic helpTopic, Action<CommandLineHelp> configure) #

Configures HelpTopic.CommandLine in place (creating it when not set): Optional compact command-line layout; null retains the PowerShell help layout.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
configure System.Action<ConsoleMonster.Help.CommandLineHelp> required
Configures the value.

Returns

HelpTopic The same instance.
CommonParameters 4 overloads
public static HelpTopic CommonParameters(HelpTopic helpTopic, bool value) #

Sets HelpTopic.CommonParameters: Whether the command takes the common parameters (-Verbose, -ErrorAction and the others).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
value bool required
The value.

Returns

HelpTopic The same instance.

Examples

// C# initializer or property          // C# fluent
helpTopic.CommonParameters = value;    helpTopic.CommonParameters(value);
public static HelpTopic CommonParameters(HelpTopic helpTopic) #

Sets HelpTopic.CommonParameters to true.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance to configure.

Returns

HelpTopic The same instance.
public static HelpSyntax CommonParameters(HelpSyntax helpSyntax, bool value) #

Sets HelpSyntax.CommonParameters: Whether the common parameters follow.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax required
The instance.
value bool required
The value.

Returns

HelpSyntax The same instance.

Examples

// C# initializer or property           // C# fluent
helpSyntax.CommonParameters = value;    helpSyntax.CommonParameters(value);
public static HelpSyntax CommonParameters(HelpSyntax helpSyntax) #

Sets HelpSyntax.CommonParameters to true.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax required
The instance to configure.

Returns

HelpSyntax The same instance.
public static HelpParameter Default(HelpParameter helpParameter, string? value) #

Sets HelpParameter.Default: The default value, or null.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value string? required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property     // C# fluent
helpParameter.Default = value;    helpParameter.Default(value);
public static HelpParameter Description(HelpParameter helpParameter, string? value) #

Sets HelpParameter.Description: The description, or null.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value string? required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property         // C# fluent
helpParameter.Description = value;    helpParameter.Description(value);
Named 4 overloads
public static HelpParameter Named(HelpParameter helpParameter, bool value) #

Sets HelpParameter.Named: Whether the renderer adds one dash (default true). Supply -output for --output; false keeps a command-line positional argument unprefixed.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value bool required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property    // C# fluent
helpParameter.Named = value;     helpParameter.Named(value);
public static HelpParameter Named(HelpParameter helpParameter) #

Sets HelpParameter.Named to true.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance to configure.

Returns

HelpParameter The same instance.
public static HelpSyntaxParameter Named(HelpSyntaxParameter helpSyntaxParameter, bool value) #

Sets HelpSyntaxParameter.Named: Whether the syntax includes a name with one renderer-added dash (default true). Supply -output for --output. False renders only the positional value placeholder.

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance.
value bool required
The value.

Returns

HelpSyntaxParameter The same instance.

Examples

// C# initializer or property         // C# fluent
helpSyntaxParameter.Named = value;    helpSyntaxParameter.Named(value);
public static HelpSyntaxParameter Named(HelpSyntaxParameter helpSyntaxParameter) #

Sets HelpSyntaxParameter.Named to true.

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance to configure.

Returns

HelpSyntaxParameter The same instance.
public static HelpValue Note(HelpValue helpValue, string? value) #

Sets HelpValue.Note: An optional dim note displayed separately after the description.

Parameters

helpValue ConsoleMonster.Help.HelpValue required
The instance.
value string? required
The value.

Returns

HelpValue The same instance.

Examples

// C# initializer or property    // C# fluent
helpValue.Note = value;          helpValue.Note(value);
public static HelpTopic Notice(HelpTopic helpTopic, string? value) #

Sets HelpTopic.Notice: A note shown muted under the name (for example that only partial help is installed), or null.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
value string? required
The value.

Returns

HelpTopic The same instance.

Examples

// C# initializer or property    // C# fluent
helpTopic.Notice = value;        helpTopic.Notice(value);
public static HelpParameter Pipeline(HelpParameter helpParameter, string? value) #

Sets HelpParameter.Pipeline: How it takes pipeline input (for example ByValue, ByPropertyName), or null for none.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value string? required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property      // C# fluent
helpParameter.Pipeline = value;    helpParameter.Pipeline(value);
public static HelpParameter Position(HelpParameter helpParameter, string? value) #

Sets HelpParameter.Position: The position (0, 1, ...), or null when it is named only.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value string? required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property      // C# fluent
helpParameter.Position = value;    helpParameter.Position(value);
Positional 2 overloads
public static HelpSyntaxParameter Positional(HelpSyntaxParameter helpSyntaxParameter, bool value) #

Sets HelpSyntaxParameter.Positional: Whether its name may be left out (a position is given).

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance.
value bool required
The value.

Returns

HelpSyntaxParameter The same instance.

Examples

// C# initializer or property              // C# fluent
helpSyntaxParameter.Positional = value;    helpSyntaxParameter.Positional(value);
public static HelpSyntaxParameter Positional(HelpSyntaxParameter helpSyntaxParameter) #

Sets HelpSyntaxParameter.Positional to true.

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance to configure.

Returns

HelpSyntaxParameter The same instance.
public static HelpExample Remarks(HelpExample helpExample, string? value) #

Sets HelpExample.Remarks: The remarks, or null.

Parameters

helpExample ConsoleMonster.Help.HelpExample required
The instance.
value string? required
The value.

Returns

HelpExample The same instance.

Examples

// C# initializer or property    // C# fluent
helpExample.Remarks = value;     helpExample.Remarks(value);
Required 4 overloads
public static HelpParameter Required(HelpParameter helpParameter, bool value) #

Sets HelpParameter.Required: Whether it is required (in any parameter set).

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value bool required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property      // C# fluent
helpParameter.Required = value;    helpParameter.Required(value);
public static HelpParameter Required(HelpParameter helpParameter) #

Sets HelpParameter.Required to true.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance to configure.

Returns

HelpParameter The same instance.
public static HelpSyntaxParameter Required(HelpSyntaxParameter helpSyntaxParameter, bool value) #

Sets HelpSyntaxParameter.Required: Whether it is required.

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance.
value bool required
The value.

Returns

HelpSyntaxParameter The same instance.

Examples

// C# initializer or property            // C# fluent
helpSyntaxParameter.Required = value;    helpSyntaxParameter.Required(value);
public static HelpSyntaxParameter Required(HelpSyntaxParameter helpSyntaxParameter) #

Sets HelpSyntaxParameter.Required to true.

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance to configure.

Returns

HelpSyntaxParameter The same instance.
public static HelpSyntax SetName(HelpSyntax helpSyntax, string? value) #

Sets HelpSyntax.SetName: The parameter set's name, or null.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax required
The instance.
value string? required
The value.

Returns

HelpSyntax The same instance.

Examples

// C# initializer or property    // C# fluent
helpSyntax.SetName = value;      helpSyntax.SetName(value);
public static HelpTopic Synopsis(HelpTopic helpTopic, string? value) #

Sets HelpTopic.Synopsis: The one-line summary, or null.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic required
The instance.
value string? required
The value.

Returns

HelpTopic The same instance.

Examples

// C# initializer or property    // C# fluent
helpTopic.Synopsis = value;      helpTopic.Synopsis(value);
Type 2 overloads
public static HelpParameter Type(HelpParameter helpParameter, string? value) #

Sets HelpParameter.Type: The type, or null.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter required
The instance.
value string? required
The value.

Returns

HelpParameter The same instance.

Examples

// C# initializer or property    // C# fluent
helpParameter.Type = value;      helpParameter.Type(value);
public static HelpSyntaxParameter Type(HelpSyntaxParameter helpSyntaxParameter, string? value) #

Sets HelpSyntaxParameter.Type: The value type (for example string[]), or null for a switch.

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter required
The instance.
value string? required
The value.

Returns

HelpSyntaxParameter The same instance.

Examples

// C# initializer or property        // C# fluent
helpSyntaxParameter.Type = value;    helpSyntaxParameter.Type(value);
public static CommandLineHelp Usage(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.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Help.CommandLineHelp { Usage = value };    commandLineHelp.Usage(value);
public static CommandLineHelp ValuesHeading(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.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Help.CommandLineHelp { ValuesHeading = value };    commandLineHelp.ValuesHeading(value);