Skip to content
ConsoleMonster

API Reference

Class

HelpParameterFluent

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

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

Inheritance

  • Object
  • HelpParameterFluent

Methods

public static HelpParameter AddAliase(HelpParameter helpParameter, String item) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
item System.String requiredposition: 1
The item.

Returns

The same instance.

AddAliases 2 overloads
public static HelpParameter AddAliases(HelpParameter helpParameter, params String[] items) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
items System.String[] requiredposition: 1
The items, in order.

Returns

The same instance.

public static HelpParameter AddAliases(HelpParameter helpParameter, IEnumerable<String> items) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
items System.Collections.Generic.IEnumerable<System.String> requiredposition: 1
The items, in order.

Returns

The same instance.

public static HelpParameter WithDefault(HelpParameter helpParameter, String? value) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HelpParameter WithDescription(HelpParameter helpParameter, String? value) #
Returns: HelpParameter

Sets HelpParameter.Description: The description, or null.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HelpParameter WithPipeline(HelpParameter helpParameter, String? value) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HelpParameter WithPosition(HelpParameter helpParameter, String? value) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HelpParameter WithRequired(HelpParameter helpParameter, Boolean value = true) #
Returns: HelpParameter

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

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.

public static HelpParameter WithType(HelpParameter helpParameter, String? value) #
Returns: HelpParameter

Sets HelpParameter.Type: The type, or null.

Parameters

helpParameter ConsoleMonster.Help.HelpParameter requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.