Class BaseHelpFormatter

Namespace: DisCatSharp.CommandsNext.Converters

Assembly: DisCatSharp.CommandsNext.dll

Represents a base class for all default help formatters.

public abstract class BaseHelpFormatter

Inheritance: object

BaseHelpFormatter

Derived: DefaultHelpFormatter

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BaseHelpFormatter(CommandContext): Creates a new help formatter for specified CommandsNext extension instance.

Properties

CommandsNext: Gets the CommandsNext extension which constructed this help formatter.

Context: Gets the context in which this formatter is being invoked.

Methods

Build(): Constructs the help message.

WithCommand(Command): Sets the command this help message will be for.

WithSubcommands(IEnumerable<Command>): Sets the subcommands for this command, if applicable. This method will be called with filtered data.