API Reference
HelpTopicFluent
The fluent methods of HelpTopic, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.
Inheritance
- Object
- HelpTopicFluent
Methods
public static HelpTopic AddDescription(HelpTopic helpTopic, String item) #HelpTopicAdds an item to HelpTopic.Description: The description paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item System.String
- The item.
Returns
The same instance.
public static HelpTopic AddDescription(HelpTopic helpTopic, params String[] items) #HelpTopicAdds items to HelpTopic.Description: The description paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.String[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddDescription(HelpTopic helpTopic, IEnumerable<String> items) #HelpTopicAdds items to HelpTopic.Description: The description paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<System.String>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddExample(HelpTopic helpTopic, HelpExample item) #HelpTopicAdds an item to HelpTopic.Examples: The examples.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpExample
- The item.
Returns
The same instance.
public static HelpTopic AddExamples(HelpTopic helpTopic, params HelpExample[] items) #HelpTopicAdds items to HelpTopic.Examples: The examples.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpExample[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddExamples(HelpTopic helpTopic, IEnumerable<HelpExample> items) #HelpTopicAdds items to HelpTopic.Examples: The examples.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpExample>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddInput(HelpTopic helpTopic, String item) #HelpTopicAdds an item to HelpTopic.Inputs: The input types (with an optional description after a tab).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item System.String
- The item.
Returns
The same instance.
public static HelpTopic AddInputs(HelpTopic helpTopic, params String[] items) #HelpTopicAdds items to HelpTopic.Inputs: The input types (with an optional description after a tab).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.String[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddInputs(HelpTopic helpTopic, IEnumerable<String> items) #HelpTopicAdds items to HelpTopic.Inputs: The input types (with an optional description after a tab).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<System.String>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddLink(HelpTopic helpTopic, HelpLink item) #HelpTopicAdds an item to HelpTopic.Links: The related links.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpLink
- The item.
Returns
The same instance.
public static HelpTopic AddLinks(HelpTopic helpTopic, params HelpLink[] items) #HelpTopicAdds items to HelpTopic.Links: The related links.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpLink[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddLinks(HelpTopic helpTopic, IEnumerable<HelpLink> items) #HelpTopicAdds items to HelpTopic.Links: The related links.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpLink>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddNote(HelpTopic helpTopic, String item) #HelpTopicAdds an item to HelpTopic.Notes: The notes paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item System.String
- The item.
Returns
The same instance.
public static HelpTopic AddNotes(HelpTopic helpTopic, params String[] items) #HelpTopicAdds items to HelpTopic.Notes: The notes paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.String[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddNotes(HelpTopic helpTopic, IEnumerable<String> items) #HelpTopicAdds items to HelpTopic.Notes: The notes paragraphs.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<System.String>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddOutput(HelpTopic helpTopic, String item) #HelpTopicAdds an item to HelpTopic.Outputs: The output types (with an optional description after a tab).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item System.String
- The item.
Returns
The same instance.
public static HelpTopic AddOutputs(HelpTopic helpTopic, params String[] items) #HelpTopicAdds items to HelpTopic.Outputs: The output types (with an optional description after a tab).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.String[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddOutputs(HelpTopic helpTopic, IEnumerable<String> items) #HelpTopicAdds items to HelpTopic.Outputs: The output types (with an optional description after a tab).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<System.String>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddParameter(HelpTopic helpTopic, HelpParameter item) #HelpTopicAdds an item to HelpTopic.Parameters: The parameters, in help order.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpParameter
- The item.
Returns
The same instance.
public static HelpTopic AddParameters(HelpTopic helpTopic, params HelpParameter[] items) #HelpTopicAdds items to HelpTopic.Parameters: The parameters, in help order.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpParameter[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddParameters(HelpTopic helpTopic, IEnumerable<HelpParameter> items) #HelpTopicAdds items to HelpTopic.Parameters: The parameters, in help order.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpParameter>
- The items, in order.
Returns
The same instance.
public static HelpTopic AddSyntax(HelpTopic helpTopic, HelpSyntax item) #HelpTopicAdds an item to HelpTopic.Syntax: One syntax per parameter set.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- item ConsoleMonster.Help.HelpSyntax
- The item.
Returns
The same instance.
public static HelpTopic AddSyntax(HelpTopic helpTopic, params HelpSyntax[] items) #HelpTopicAdds items to HelpTopic.Syntax: One syntax per parameter set.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items ConsoleMonster.Help.HelpSyntax[]
- The items, in order.
Returns
The same instance.
public static HelpTopic AddSyntax(HelpTopic helpTopic, IEnumerable<HelpSyntax> items) #HelpTopicAdds items to HelpTopic.Syntax: One syntax per parameter set.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntax>
- The items, in order.
Returns
The same instance.
public static HelpTopic WithCommonParameters(HelpTopic helpTopic, Boolean value = true) #HelpTopicSets HelpTopic.CommonParameters: Whether the command takes the common parameters (-Verbose, -ErrorAction and the others).
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static HelpTopic WithNotice(HelpTopic helpTopic, String? value) #HelpTopicSets HelpTopic.Notice: A note shown muted under the name (for example that only partial help is installed), or null.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- value System.String?
- The value.
Returns
The same instance.
public static HelpTopic WithSynopsis(HelpTopic helpTopic, String? value) #HelpTopicSets HelpTopic.Synopsis: The one-line summary, or null.
Parameters
- helpTopic ConsoleMonster.Help.HelpTopic
- The instance.
- value System.String?
- The value.
Returns
The same instance.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?