API Reference

Class

HelpParameter

Edit on GitHub

Namespace ConsoleMonster.Help

Assembly ConsoleMonster

Source HelpTopic.cs:121

Modifiers sealed

A parameter's details for the parameter table.

Inheritance

Object
HelpParameter

Usage

Explore 37 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 17

Extension method HelpParameter.AddAliase
Extension method HelpParameter.AddAliases
Extension method HelpParameter.WithDefault
Extension method HelpParameter.WithDescription
Extension method HelpParameter.WithPipeline
Extension method HelpParameter.WithPosition
Extension method HelpParameter.WithRequired
Extension method HelpParameter.WithType
Method HelpParameterFluent.AddAliase
Method HelpParameterFluent.AddAliases
Method HelpParameterFluent.WithDefault
Method HelpParameterFluent.WithDescription
Method HelpParameterFluent.WithPipeline
Method HelpParameterFluent.WithPosition
Method HelpParameterFluent.WithRequired
Method HelpParameterFluent.WithType
Property HelpTopic.Parameters

Accepted by parameters 20

Extension method HelpParameter.AddAliase parameter helpParameter
Extension method HelpParameter.AddAliases parameter helpParameter
Extension method HelpParameter.WithDefault parameter helpParameter
Extension method HelpParameter.WithDescription parameter helpParameter
Extension method HelpParameter.WithPipeline parameter helpParameter
Extension method HelpParameter.WithPosition parameter helpParameter
Extension method HelpParameter.WithRequired parameter helpParameter
Extension method HelpParameter.WithType parameter helpParameter
Method HelpParameterFluent.AddAliase parameter helpParameter
Method HelpParameterFluent.AddAliases parameter helpParameter
Method HelpParameterFluent.WithDefault parameter helpParameter
Method HelpParameterFluent.WithDescription parameter helpParameter
Method HelpParameterFluent.WithPipeline parameter helpParameter
Method HelpParameterFluent.WithPosition parameter helpParameter
Method HelpParameterFluent.WithRequired parameter helpParameter
Method HelpParameterFluent.WithType parameter helpParameter
Extension method HelpTopic.AddParameter parameter item
Extension method HelpTopic.AddParameters parameter items
Method HelpTopicFluent.AddParameter parameter item
Method HelpTopicFluent.AddParameters parameter items

Constructors

public HelpParameter(String name) #

HelpTopic.cs:121

Creates a parameter.

Parameters

name System.String requiredposition: 0: The name without the dash.

Inherited Methods

Properties

public String Name { get; } #

HelpTopic.cs:103

The name without the dash.

public String? Type { get; set; } #

HelpTopic.cs:106

The type, or null.

public Boolean Required { get; set; } #

HelpTopic.cs:109

Whether it is required (in any parameter set).

public String? Position { get; set; } #

HelpTopic.cs:112

The position (0, 1, ...), or null when it is named only.

public String? Pipeline { get; set; } #

HelpTopic.cs:115

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

public String? Default { get; set; } #

HelpTopic.cs:118

The default value, or null.

public IList<String> Aliases { get; } #

HelpTopic.cs:121

The aliases, or empty.

public String? Description { get; set; } #

HelpTopic.cs:124

The description, or null.

Extension 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.