API Reference

Class

HelpSyntaxParameter

Edit on GitHub

Namespace ConsoleMonster.Help

Assembly ConsoleMonster

Source HelpTopic.cs:77

Modifiers sealed

A parameter as it appears in a syntax line.

Inheritance

Object
HelpSyntaxParameter

Usage

Explore 17 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 7

Property HelpSyntax.Parameters
Extension method HelpSyntaxParameter.WithPositional
Extension method HelpSyntaxParameter.WithRequired
Extension method HelpSyntaxParameter.WithType
Method HelpSyntaxParameterFluent.WithPositional
Method HelpSyntaxParameterFluent.WithRequired
Method HelpSyntaxParameterFluent.WithType

Accepted by parameters 10

Extension method HelpSyntax.AddParameter parameter item
Extension method HelpSyntax.AddParameters parameter items
Method HelpSyntaxFluent.AddParameter parameter item
Method HelpSyntaxFluent.AddParameters parameter items
Extension method HelpSyntaxParameter.WithPositional parameter helpSyntaxParameter
Extension method HelpSyntaxParameter.WithRequired parameter helpSyntaxParameter
Extension method HelpSyntaxParameter.WithType parameter helpSyntaxParameter
Method HelpSyntaxParameterFluent.WithPositional parameter helpSyntaxParameter
Method HelpSyntaxParameterFluent.WithRequired parameter helpSyntaxParameter
Method HelpSyntaxParameterFluent.WithType parameter helpSyntaxParameter

Constructors

public HelpSyntaxParameter(String name) #

HelpTopic.cs:77

Creates a syntax parameter.

Parameters

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

Inherited Methods

Properties

public String Name { get; } #

HelpTopic.cs:82

The name without the dash.

public String? Type { get; set; } #

HelpTopic.cs:85

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

public Boolean Required { get; set; } #

HelpTopic.cs:88

Whether it is required.

public Boolean Positional { get; set; } #

HelpTopic.cs:91

Whether its name may be left out (a position is given).

Extension Methods

public static HelpSyntaxParameter WithPositional(HelpSyntaxParameter helpSyntaxParameter, Boolean value = true) #

Returns: HelpSyntaxParameter

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

Parameters

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

Returns

The same instance.

public static HelpSyntaxParameter WithRequired(HelpSyntaxParameter helpSyntaxParameter, Boolean value = true) #

Returns: HelpSyntaxParameter

Sets HelpSyntaxParameter.Required: Whether it is required.

Parameters

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

Returns

The same instance.

public static HelpSyntaxParameter WithType(HelpSyntaxParameter helpSyntaxParameter, String? value) #

Returns: HelpSyntaxParameter

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

Parameters

helpSyntaxParameter ConsoleMonster.Help.HelpSyntaxParameter requiredposition: 0: The instance.
value System.String? requiredposition: 1: The value.

Returns

The same instance.