HelpFluent
ConsoleMonster.Help
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
- The instance.
- item string
- The item.
public static HelpParameter AddAliases(HelpParameter helpParameter, params string[] items) #Adds items to HelpParameter.Aliases: The aliases, or empty.
Parameters
- helpParameter ConsoleMonster.Help.HelpParameter
- The instance.
- items string[]
- The items, in order.
public static HelpParameter AddAliases(HelpParameter helpParameter, IEnumerable<string> items) #Adds items to HelpParameter.Aliases: The aliases, or empty.
Parameters
- helpParameter ConsoleMonster.Help.HelpParameter
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
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
- The instance.
- item ConsoleMonster.Help.HelpCommand
- The item.
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
- The instance.
- items ConsoleMonster.Help.HelpCommand[]
- The items, in order.
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
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpCommand>
- The items, in order.
public static HelpTopic AddDescription(HelpTopic helpTopic, string item) #Adds an item to HelpTopic.Description: The description paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item string
- The item.
public static HelpTopic AddDescription(HelpTopic helpTopic, params string[] items) #Adds items to HelpTopic.Description: The description paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items string[]
- The items, in order.
public static HelpTopic AddDescription(HelpTopic helpTopic, IEnumerable<string> items) #Adds items to HelpTopic.Description: The description paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
public static HelpTopic AddExample(HelpTopic helpTopic, HelpExample item) #Adds an item to HelpTopic.Examples: The examples.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpExample
- The item.
public static HelpTopic AddExamples(HelpTopic helpTopic, params HelpExample[] items) #Adds items to HelpTopic.Examples: The examples.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpExample[]
- The items, in order.
public static HelpTopic AddExamples(HelpTopic helpTopic, IEnumerable<HelpExample> items) #Adds items to HelpTopic.Examples: The examples.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpExample>
- The items, in order.
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
- The instance.
- item string
- The item.
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
- The instance.
- items string[]
- The items, in order.
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
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
public static HelpTopic AddLink(HelpTopic helpTopic, HelpLink item) #Adds an item to HelpTopic.Links: The related links.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpLink
- The item.
public static HelpTopic AddLinks(HelpTopic helpTopic, params HelpLink[] items) #Adds items to HelpTopic.Links: The related links.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpLink[]
- The items, in order.
public static HelpTopic AddLinks(HelpTopic helpTopic, IEnumerable<HelpLink> items) #Adds items to HelpTopic.Links: The related links.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpLink>
- The items, in order.
public static HelpTopic AddNote(HelpTopic helpTopic, string item) #Adds an item to HelpTopic.Notes: The notes paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item string
- The item.
public static HelpTopic AddNotes(HelpTopic helpTopic, params string[] items) #Adds items to HelpTopic.Notes: The notes paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items string[]
- The items, in order.
public static HelpTopic AddNotes(HelpTopic helpTopic, IEnumerable<string> items) #Adds items to HelpTopic.Notes: The notes paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
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
- The instance.
- item string
- The item.
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
- The instance.
- items string[]
- The items, in order.
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
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
public static HelpTopic AddParameter(HelpTopic helpTopic, HelpParameter item) #Adds an item to HelpTopic.Parameters: The parameters, in help order.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpParameter
- The item.
public static HelpSyntax AddParameter(HelpSyntax helpSyntax, HelpSyntaxParameter item) #Adds an item to HelpSyntax.Parameters: The parameters.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- item ConsoleMonster.Help.HelpSyntaxParameter
- The item.
public static HelpTopic AddParameters(HelpTopic helpTopic, params HelpParameter[] items) #Adds items to HelpTopic.Parameters: The parameters, in help order.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpParameter[]
- The items, in order.
public static HelpTopic AddParameters(HelpTopic helpTopic, IEnumerable<HelpParameter> items) #Adds items to HelpTopic.Parameters: The parameters, in help order.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpParameter>
- The items, in order.
public static HelpSyntax AddParameters(HelpSyntax helpSyntax, params HelpSyntaxParameter[] items) #Adds items to HelpSyntax.Parameters: The parameters.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- items ConsoleMonster.Help.HelpSyntaxParameter[]
- The items, in order.
public static HelpSyntax AddParameters(HelpSyntax helpSyntax, IEnumerable<HelpSyntaxParameter> items) #Adds items to HelpSyntax.Parameters: The parameters.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntaxParameter>
- The items, in order.
public static HelpTopic AddSyntax(HelpTopic helpTopic, HelpSyntax item) #Adds an item to HelpTopic.Syntax: One syntax per parameter set.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpSyntax
- The item.
public static HelpTopic AddSyntax(HelpTopic helpTopic, params HelpSyntax[] items) #Adds items to HelpTopic.Syntax: One syntax per parameter set.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpSyntax[]
- The items, in order.
public static HelpTopic AddSyntax(HelpTopic helpTopic, IEnumerable<HelpSyntax> items) #Adds items to HelpTopic.Syntax: One syntax per parameter set.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntax>
- The items, in order.
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
- The instance.
- item ConsoleMonster.Help.HelpValue
- The item.
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
- The instance.
- items ConsoleMonster.Help.HelpValue[]
- The items, in order.
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
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpValue>
- The items, in order.
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
- The instance.
- value ConsoleMonster.Help.CommandLineHelp?
- The value.
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
- The instance.
- configure System.Action<ConsoleMonster.Help.CommandLineHelp>
- Configures the value.
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
- The instance.
- value bool
- The value.
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
- The instance to configure.
public static HelpSyntax CommonParameters(HelpSyntax helpSyntax, bool value) #Sets HelpSyntax.CommonParameters: Whether the common parameters follow.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- value bool
- The value.
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
- The instance to configure.
public static HelpParameter Default(HelpParameter helpParameter, string? value) #Sets HelpParameter.Default: The default value, or null.
Parameters
- helpParameter ConsoleMonster.Help.HelpParameter
- The instance.
- value string?
- The value.
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
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
helpParameter.Description = value; helpParameter.Description(value);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
- The instance.
- value bool
- The value.
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
- The instance to configure.
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
- The instance.
- value bool
- The value.
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
- The instance to configure.
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
- The instance.
- value string?
- The value.
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
- The instance.
- value string?
- The value.
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
- The instance.
- value string?
- The value.
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
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
helpParameter.Position = value; helpParameter.Position(value);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
- The instance.
- value bool
- The value.
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
- The instance to configure.
public static HelpExample Remarks(HelpExample helpExample, string? value) #Sets HelpExample.Remarks: The remarks, or null.
Parameters
- helpExample ConsoleMonster.Help.HelpExample
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
helpExample.Remarks = value; helpExample.Remarks(value);public static HelpParameter Required(HelpParameter helpParameter, bool value) #Sets HelpParameter.Required: Whether it is required (in any parameter set).
Parameters
- helpParameter ConsoleMonster.Help.HelpParameter
- The instance.
- value bool
- The value.
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
- The instance to configure.
public static HelpSyntaxParameter Required(HelpSyntaxParameter helpSyntaxParameter, bool value) #Sets HelpSyntaxParameter.Required: Whether it is required.
Parameters
- helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter
- The instance.
- value bool
- The value.
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
- The instance to configure.
public static HelpSyntax SetName(HelpSyntax helpSyntax, string? value) #Sets HelpSyntax.SetName: The parameter set's name, or null.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- value string?
- The value.
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
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
helpTopic.Synopsis = value; helpTopic.Synopsis(value);public static HelpParameter Type(HelpParameter helpParameter, string? value) #Sets HelpParameter.Type: The type, or null.
Parameters
- helpParameter ConsoleMonster.Help.HelpParameter
- The instance.
- value string?
- The value.
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
- The instance.
- value string?
- The value.
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
- The instance.
- value string
- The value.
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
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Help.CommandLineHelp { ValuesHeading = value }; commandLineHelp.ValuesHeading(value);