Class CommandHelp

Prints out help information for a CommandPalette

Inheritance
object
CommandHelp
Inherited Members
Namespace: Petabridge.Cmd
Assembly: Petabridge.Cmd.Common.dll
Syntax
public sealed class CommandHelp

Constructors

CommandHelp(CommandPalette)

Declaration
public CommandHelp(CommandPalette palette)
Parameters
Type Name Description
CommandPalette palette

Properties

Palette

The palette for this CommandHelp

Declaration
public CommandPalette Palette { get; }
Property Value
Type Description
CommandPalette

Methods

GetHelp(HelpCommand)

Declaration
public CommandResponse GetHelp(HelpCommand command)
Parameters
Type Name Description
HelpCommand command
Returns
Type Description
CommandResponse

GlobalHelp(Dictionary<string, CommandHelp>)

Declaration
public static CommandResponse GlobalHelp(Dictionary<string, CommandHelp> commands)
Parameters
Type Name Description
Dictionary<string, CommandHelp> commands
Returns
Type Description
CommandResponse