Class CommandsListBuilder

Utility class that will build default commands list.

Inheritance

System.Object

CommandsListBuilder

Namespace: TehGM.Wolfringo.Commands.Help

Assembly: Wolfringo.Commands.dll

Syntax

public class CommandsListBuilder

Constructors

CommandsListBuilder(IEnumerable<ICommandInstanceDescriptor>)

Creates a new Builder.

Declaration

public CommandsListBuilder(IEnumerable<ICommandInstanceDescriptor> commands)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ICommandInstanceDescriptor>	commands	List of command descriptors.

CommandsListBuilder(ICommandsService)

Creates a new Builder.

Declaration

public CommandsListBuilder(ICommandsService commandsService)

Parameters

Type	Name	Description
ICommandsService	commandsService	Commands service with loaded commands.

Properties

ListCommandsWithoutSummaries

Whether commands without summaries will be listed.

Declaration

public bool ListCommandsWithoutSummaries { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to true.

PrependedPrefix

Prefix that should be prepended to each command. Set to null to not prepend any.

Declaration

public string PrependedPrefix { get; set; }

Property Value

Type	Description
System.String

SpaceCategories

Whether categories should have extra space between themselves.

Declaration

public bool SpaceCategories { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Defaults to true.

SummarySeparator

String to separate command's display name and summary.

Declaration

public string SummarySeparator { get; set; }

Property Value

Type	Description
System.String

Remarks

Defaults to - (four spaces, dash, and one more space).

Methods

GetCommandsList()

Builds a commands list.

Declaration

public string GetCommandsList()

Returns

Type	Description
System.String	String with commands list. Empty string if there's no commands.

ToString()

Builds a commands list.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String with commands list. Empty string if there's no commands.

Overrides

System.Object.ToString()