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

API Reference

Class

HelpExample

Namespace ConsoleMonster.Help

Assembly ConsoleMonster

Source HelpTopic.cs:132

Modifiers sealed

One example: a title, the code and the remarks.

Inheritance

Object
HelpExample

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

Extension method HelpExample.WithRemarks
Method HelpExampleFluent.WithRemarks
Property HelpTopic.Examples

Accepted by parameters 6

Extension method HelpExample.WithRemarks parameter helpExample
Method HelpExampleFluent.WithRemarks parameter helpExample
Extension method HelpTopic.AddExample parameter item
Extension method HelpTopic.AddExamples parameter items
Method HelpTopicFluent.AddExample parameter item
Method HelpTopicFluent.AddExamples parameter items

Constructors

public HelpExample(String? title, String code) #

HelpTopic.cs:132

Creates an example.

Parameters

title System.String? requiredposition: 0: The title.
code System.String requiredposition: 1: The code.

Inherited Methods

Properties

public String? Title { get; } #

HelpTopic.cs:138

The title, or null.

public String Code { get; } #

HelpTopic.cs:141

The code (PowerShell).

public String? Remarks { get; set; } #

HelpTopic.cs:144

The remarks, or null.

Extension Methods

public static HelpExample WithRemarks(HelpExample helpExample, String? value) #

Returns: HelpExample

Sets HelpExample.Remarks: The remarks, or null.

Parameters

helpExample ConsoleMonster.Help.HelpExample requiredposition: 0: The instance.
value System.String? requiredposition: 1: The value.

Returns

The same instance.