Skip to content

What ConsoleMonster draws, live and printed once.
- Widgets Every widget at every colour and glyph tier.
- Tables Width negotiation, cards, presenters and totals.
- Live dashboards Recorded runs, replayed frame by frame.
- Live runs Many items in parallel, watch views and Pester runs.
- Interactive Prompts, menus, forms and the grid.
- PowerShell Cmdlets on 5.1 and 7, with their real output.
Install, configure and look things up.
- Docs Install, detection, themes, live sessions, recording.
- Guides Coming from Write-Color, Spectre.Console or Format-Table.
- .NET API Every public type and member.
- Commands Every cmdlet with its parameters.
- Benchmarks Frame cost, update rates and memory.
Current section: .NET API

Class

HelpValue

ConsoleMonster.Help

Namespace: ConsoleMonster.Help
Assembly: ConsoleMonster
Source: HelpValue.cs:8
Modifiers: sealed

A named value or value family shown in compact CLI help.

Inheritance

object
HelpValue

Usage

Explore 9 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 3

Accepted by parameters 6

Extension method CommandLineHelp.AddValue parameter item
Extension method CommandLineHelp.AddValues parameter items
Method CommandLineHelpFluent.AddValue parameter item
Method CommandLineHelpFluent.AddValues parameter items
Extension method HelpValue.WithNote parameter helpValue
Method HelpValueFluent.WithNote parameter helpValue

Constructors

public HelpValue(string name, string? description, string? group = null) #

Creates a catalog entry.

Parameters

name string required: The literal value syntax.
description string? required: Its description.
group string? = null optional: An optional group heading.

Inherited Methods

Properties

public string Name { get; } #

HelpValue.cs:14

The literal value syntax.

public string Description { get; } #

HelpValue.cs:16

The description.

public string? Group { get; } #

HelpValue.cs:18

The optional group heading.

public string? Note { get; set; } #

HelpValue.cs:20

An optional dim note displayed separately after the description.

Extension Methods

public static HelpValue WithNote(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.