API Reference

Class

HelpTopic

Namespace ConsoleMonster.Help

Assembly ConsoleMonster

Modifiers sealed

A command's help, as structured data: what HelpView shows. Show-ConsoleHelp fills it from PowerShell's Get-Help objects; .NET hosts can fill it from their own command descriptions.

Inheritance

Object
HelpTopic

Usage

Explore 72 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 35

Extension method HelpTopic.AddDescription
Extension method HelpTopic.AddExample
Extension method HelpTopic.AddExamples
Extension method HelpTopic.AddInput
Extension method HelpTopic.AddInputs
Extension method HelpTopic.AddLink
Extension method HelpTopic.AddLinks
Extension method HelpTopic.AddNote
Extension method HelpTopic.AddNotes
Extension method HelpTopic.AddOutput
Extension method HelpTopic.AddOutputs
Extension method HelpTopic.AddParameter
Extension method HelpTopic.AddParameters
Extension method HelpTopic.AddSyntax
Extension method HelpTopic.WithCommonParameters
Extension method HelpTopic.WithNotice
Extension method HelpTopic.WithSynopsis
Method HelpTopicFluent.AddDescription
Method HelpTopicFluent.AddExample
Method HelpTopicFluent.AddExamples
Method HelpTopicFluent.AddInput
Method HelpTopicFluent.AddInputs
Method HelpTopicFluent.AddLink
Method HelpTopicFluent.AddLinks
Method HelpTopicFluent.AddNote
Method HelpTopicFluent.AddNotes
Method HelpTopicFluent.AddOutput
Method HelpTopicFluent.AddOutputs
Method HelpTopicFluent.AddParameter
Method HelpTopicFluent.AddParameters
Method HelpTopicFluent.AddSyntax
Method HelpTopicFluent.WithCommonParameters
Method HelpTopicFluent.WithNotice
Method HelpTopicFluent.WithSynopsis
Property HelpView.Topic

Accepted by parameters 37

Extension method HelpTopic.AddDescription parameter helpTopic
Extension method HelpTopic.AddExample parameter helpTopic
Extension method HelpTopic.AddExamples parameter helpTopic
Extension method HelpTopic.AddInput parameter helpTopic
Extension method HelpTopic.AddInputs parameter helpTopic
Extension method HelpTopic.AddLink parameter helpTopic
Extension method HelpTopic.AddLinks parameter helpTopic
Extension method HelpTopic.AddNote parameter helpTopic
Extension method HelpTopic.AddNotes parameter helpTopic
Extension method HelpTopic.AddOutput parameter helpTopic
Extension method HelpTopic.AddOutputs parameter helpTopic
Extension method HelpTopic.AddParameter parameter helpTopic
Extension method HelpTopic.AddParameters parameter helpTopic
Extension method HelpTopic.AddSyntax parameter helpTopic
Extension method HelpTopic.WithCommonParameters parameter helpTopic
Extension method HelpTopic.WithNotice parameter helpTopic
Extension method HelpTopic.WithSynopsis parameter helpTopic
Method HelpTopicFluent.AddDescription parameter helpTopic
Method HelpTopicFluent.AddExample parameter helpTopic
Method HelpTopicFluent.AddExamples parameter helpTopic
Method HelpTopicFluent.AddInput parameter helpTopic
Method HelpTopicFluent.AddInputs parameter helpTopic
Method HelpTopicFluent.AddLink parameter helpTopic
Method HelpTopicFluent.AddLinks parameter helpTopic
Method HelpTopicFluent.AddNote parameter helpTopic
Method HelpTopicFluent.AddNotes parameter helpTopic
Method HelpTopicFluent.AddOutput parameter helpTopic
Method HelpTopicFluent.AddOutputs parameter helpTopic
Method HelpTopicFluent.AddParameter parameter helpTopic
Method HelpTopicFluent.AddParameters parameter helpTopic
Method HelpTopicFluent.AddSyntax parameter helpTopic
Method HelpTopicFluent.WithCommonParameters parameter helpTopic
Method HelpTopicFluent.WithNotice parameter helpTopic
Method HelpTopicFluent.WithSynopsis parameter helpTopic
Constructor HelpView.HelpView parameter topic
Extension method HelpView.WithTopic parameter configure
Method HelpViewFluent.WithTopic parameter configure

Constructors

public HelpTopic(String name) #

HelpTopic.cs:25

Creates a topic.

Parameters

name System.String requiredposition: 0: The command name.

Inherited Methods

Properties

public String Name { get; } #

HelpTopic.cs:16

The command name.

public String? Synopsis { get; set; } #

HelpTopic.cs:19

The one-line summary, or null.

public String? Notice { get; set; } #

HelpTopic.cs:22

A note shown muted under the name (for example that only partial help is installed), or null.

public IList<String> Description { get; } #

HelpTopic.cs:25

The description paragraphs.

public IList<HelpSyntax> Syntax { get; } #

HelpTopic.cs:28

One syntax per parameter set.

public IList<HelpParameter> Parameters { get; } #

HelpTopic.cs:31

The parameters, in help order.

public Boolean CommonParameters { get; set; } #

HelpTopic.cs:34

Whether the command takes the common parameters (-Verbose, -ErrorAction and the others).

public IList<HelpExample> Examples { get; } #

HelpTopic.cs:37

The examples.

public IList<String> Inputs { get; } #

HelpTopic.cs:40

The input types (with an optional description after a tab).

public IList<String> Outputs { get; } #

HelpTopic.cs:43

The output types (with an optional description after a tab).

public IList<String> Notes { get; } #

HelpTopic.cs:46

The notes paragraphs.

public IList<HelpLink> Links { get; } #

HelpTopic.cs:49

The related links.

Extension Methods

AddDescription 3 overloads

public static HelpTopic AddDescription(HelpTopic helpTopic, String item) #

Returns: HelpTopic

Adds an item to HelpTopic.Description: The description paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item System.String requiredposition: 1: The item.

Returns

The same instance.

public static HelpTopic AddDescription(HelpTopic helpTopic, params String[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Description: The description paragraphs.

Parameters

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

Returns

The same instance.

public static HelpTopic AddDescription(HelpTopic helpTopic, IEnumerable<String> items) #

Returns: HelpTopic

Adds items to HelpTopic.Description: The description paragraphs.

Parameters

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

Returns

The same instance.

public static HelpTopic AddExample(HelpTopic helpTopic, HelpExample item) #

Returns: HelpTopic

Adds an item to HelpTopic.Examples: The examples.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item ConsoleMonster.Help.HelpExample requiredposition: 1: The item.

Returns

The same instance.

AddExamples 2 overloads

public static HelpTopic AddExamples(HelpTopic helpTopic, params HelpExample[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Examples: The examples.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items ConsoleMonster.Help.HelpExample[] requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic AddExamples(HelpTopic helpTopic, IEnumerable<HelpExample> items) #

Returns: HelpTopic

Adds items to HelpTopic.Examples: The examples.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpExample> requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic AddInput(HelpTopic helpTopic, String item) #

Returns: HelpTopic

Adds an item to HelpTopic.Inputs: The input types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item System.String requiredposition: 1: The item.

Returns

The same instance.

AddInputs 2 overloads

public static HelpTopic AddInputs(HelpTopic helpTopic, params String[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Inputs: The input types (with an optional description after a tab).

Parameters

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

Returns

The same instance.

public static HelpTopic AddInputs(HelpTopic helpTopic, IEnumerable<String> items) #

Returns: HelpTopic

Adds items to HelpTopic.Inputs: The input types (with an optional description after a tab).

Parameters

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

Returns

The same instance.

public static HelpTopic AddLink(HelpTopic helpTopic, HelpLink item) #

Returns: HelpTopic

Adds an item to HelpTopic.Links: The related links.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item ConsoleMonster.Help.HelpLink requiredposition: 1: The item.

Returns

The same instance.

AddLinks 2 overloads

public static HelpTopic AddLinks(HelpTopic helpTopic, params HelpLink[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Links: The related links.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items ConsoleMonster.Help.HelpLink[] requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic AddLinks(HelpTopic helpTopic, IEnumerable<HelpLink> items) #

Returns: HelpTopic

Adds items to HelpTopic.Links: The related links.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpLink> requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic AddNote(HelpTopic helpTopic, String item) #

Returns: HelpTopic

Adds an item to HelpTopic.Notes: The notes paragraphs.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item System.String requiredposition: 1: The item.

Returns

The same instance.

AddNotes 2 overloads

public static HelpTopic AddNotes(HelpTopic helpTopic, params String[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Notes: The notes paragraphs.

Parameters

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

Returns

The same instance.

public static HelpTopic AddNotes(HelpTopic helpTopic, IEnumerable<String> items) #

Returns: HelpTopic

Adds items to HelpTopic.Notes: The notes paragraphs.

Parameters

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

Returns

The same instance.

public static HelpTopic AddOutput(HelpTopic helpTopic, String item) #

Returns: HelpTopic

Adds an item to HelpTopic.Outputs: The output types (with an optional description after a tab).

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item System.String requiredposition: 1: The item.

Returns

The same instance.

AddOutputs 2 overloads

public static HelpTopic AddOutputs(HelpTopic helpTopic, params String[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Outputs: The output types (with an optional description after a tab).

Parameters

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

Returns

The same instance.

public static HelpTopic AddOutputs(HelpTopic helpTopic, IEnumerable<String> items) #

Returns: HelpTopic

Adds items to HelpTopic.Outputs: The output types (with an optional description after a tab).

Parameters

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

Returns

The same instance.

public static HelpTopic AddParameter(HelpTopic helpTopic, HelpParameter item) #

Returns: HelpTopic

Adds an item to HelpTopic.Parameters: The parameters, in help order.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item ConsoleMonster.Help.HelpParameter requiredposition: 1: The item.

Returns

The same instance.

AddParameters 2 overloads

public static HelpTopic AddParameters(HelpTopic helpTopic, params HelpParameter[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Parameters: The parameters, in help order.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items ConsoleMonster.Help.HelpParameter[] requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic AddParameters(HelpTopic helpTopic, IEnumerable<HelpParameter> items) #

Returns: HelpTopic

Adds items to HelpTopic.Parameters: The parameters, in help order.

Parameters

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

Returns

The same instance.

AddSyntax 3 overloads

public static HelpTopic AddSyntax(HelpTopic helpTopic, HelpSyntax item) #

Returns: HelpTopic

Adds an item to HelpTopic.Syntax: One syntax per parameter set.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
item ConsoleMonster.Help.HelpSyntax requiredposition: 1: The item.

Returns

The same instance.

public static HelpTopic AddSyntax(HelpTopic helpTopic, params HelpSyntax[] items) #

Returns: HelpTopic

Adds items to HelpTopic.Syntax: One syntax per parameter set.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items ConsoleMonster.Help.HelpSyntax[] requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic AddSyntax(HelpTopic helpTopic, IEnumerable<HelpSyntax> items) #

Returns: HelpTopic

Adds items to HelpTopic.Syntax: One syntax per parameter set.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntax> requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpTopic WithCommonParameters(HelpTopic helpTopic, Boolean value = true) #

Returns: HelpTopic

Sets HelpTopic.CommonParameters: Whether the command takes the common parameters (-Verbose, -ErrorAction and the others).

Parameters

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

Returns

The same instance.

public static HelpTopic WithNotice(HelpTopic helpTopic, String? value) #

Returns: HelpTopic

Sets HelpTopic.Notice: A note shown muted under the name (for example that only partial help is installed), or null.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
value System.String? requiredposition: 1: The value.

Returns

The same instance.

public static HelpTopic WithSynopsis(HelpTopic helpTopic, String? value) #

Returns: HelpTopic

Sets HelpTopic.Synopsis: The one-line summary, or null.

Parameters

helpTopic ConsoleMonster.Help.HelpTopic requiredposition: 0: The instance.
value System.String? requiredposition: 1: The value.

Returns

The same instance.